Task — Kuito Documentação

Utilização

Save without submitting twice

Este tipo é usado por 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>
  );
}

Declaração do tipo

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;
}

Membros 5

Nome	Tipo	Obrigatório	Descrição
`running`só de leitura	`ReadonlySignal<boolean>`	Sim	—
`data`só de leitura	`ReadonlySignal<T>`	Sim	—
`error`só de leitura	`ReadonlySignal<unknown>`	Sim	—
`run`	`(...args: A) => Promise<T>`	Sim	—
`cancel`	`(reason?: unknown) => void`	Sim	—

run — assinaturas de método

Assinaturas

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`...args`	`A`	Sim	—

Devolve

Promise<T>

cancel — assinaturas de método

Assinaturas

(reason?: unknown): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`reason`	`unknown`	Não	—

Devolve

void

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.