Task — Kuito Documentation

Usage

Save without submitting twice

This type is used by task

tsx

import { Button, Text, VStack, task } from 'kuito';

export function SaveButton(props: { save: () => Promise<void> }) {
  const save = task(() => props.save(), { policy: 'drop' });
  return (
    <VStack gap={8}>
      <Button disabled={save.running.value} onPress={() => void save.run().catch(() => {})}>
        {save.running.value ? 'Saving…' : 'Save changes'}
      </Button>
      <Text>{save.error.value ? 'Save failed. Try again.' : ''}</Text>
    </VStack>
  );
}

Type declaration

export interface Task<A extends unknown[], T> {
  readonly running: ReadonlySignal<boolean>;
  readonly data: ReadonlySignal<T | undefined>;
  readonly error: ReadonlySignal<unknown>;
  run(...args: A): Promise<T>;
  cancel(reason?: unknown): void;
}

Members 5

Name	Type	Required	Description
`running`readonly	`ReadonlySignal<boolean>`	Yes	—
`data`readonly	`ReadonlySignal<T>`	Yes	—
`error`readonly	`ReadonlySignal<unknown>`	Yes	—
`run`	`(...args: A) => Promise<T>`	Yes	—
`cancel`	`(reason?: unknown) => void`	Yes	—

run — method signatures

Signatures

(...args: A): Promise<T>

Parameters

Name	Type	Required	Description
`...args`	`A`	Yes	—

Returns

Promise<T>

cancel — method signatures

Signatures

(reason?: unknown): void

Parameters

Name	Type	Required	Description
`reason`	`unknown`	No	—

Returns

void

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.