QueuedTaskOptions

import type { QueuedTaskOptions } from "@elie-laloum/outpost";

Paramètres et propriétés

retryOptionnel
Retry | undefined
Politique de relance des tentatives échouées ; sans elle, la tâche s’exécute une fois. Une tentative relancée répète ses effets de bord.
cacheOptionnel
TaskCacheOptions | undefined
Cache de résultat : une entrée trouvée restaure la valeur JSON sans perte enregistrée, sans tentative, usage ni effet de bord. En cas d’absence, un résultat qui n’est pas du JSON sans perte fait échouer la tâche. Refusé sur les gates, les interactions et les tâches qui renvoient un résultat de dispatch.
gateOptionnel
WorkflowGate | undefined
Définition persistée d’approbation ou pause ; son exécution exige un checkpoint et une décision de confiance correspondante.
keyRequis
string
Clé unique dans le workflow, conforme à [A-Za-z0-9][A-Za-z0-9._-]*. Les enregistrements, événements et checkpoints identifient la tâche par elle.
afterOptionnel
readonly Task<unknown>[] | undefined
Tâches qui doivent être done avant que celle-ci démarre, aucune par défaut ; seules celles-ci se lisent avec context.value().
interactionOptionnel
TaskInteraction | undefined
Contrat optionnel de saisie humaine durable ; exige un checkpoint et ne peut pas être combiné avec une gate.
conditionOptionnel
((context: TaskContext) => boolean | Promise<boolean>) | undefined
Évaluée avec attempt 0 avant l’exécution de la tâche, y compris quand un start() ultérieur la reprend ; false termine la tâche en skipped, ce qui ignore aussi ses dépendantes.
timeoutMsOptionnel
number | undefined
Délai en millisecondes de chaque tentative, entier positif jusqu’à 2147483647. À l’expiration, context.signal est annulé et la tentative échoue ; retry peut la répéter.
queueRequis
TaskQueue
File dans laquelle la tâche envoie son job et l’interroge.
handlerRequis
string
Nom du handler de worker qui exécute le job, de 1 à 512 caractères.
inputRequis
(context: TaskContext) => WorkflowJson
Construit l’entrée JSON du job depuis le contexte de tâche, par exemple les valeurs des dépendances. Appelée à chaque tentative : une valeur différente sous le même identifiant de job est refusée.
decodeRequis
(value: WorkflowJson) => T
Convertit la valeur JSON du job en résultat de la tâche ; levez une erreur pour faire échouer la tâche.
deadlineOptionnel
number | undefined
Deadline du job en millisecondes epoch ; le job devient cancelled une fois qu’elle est dépassée.
pollMsOptionnel
number | undefined
Intervalle entre deux lectures du job en millisecondes, 250 par défaut ; doit être positif.

Signature

export type QueuedTaskOptions<T> = Omit<TaskOptions<T>, "perform"> & {
  readonly queue: TaskQueue;
  readonly handler: string;
  readonly input: (context: TaskContext) => WorkflowJson;
  readonly decode: (value: WorkflowJson) => T;
  readonly deadline?: number;
  readonly pollMs?: number;
};

Paramètres et propriétés

Signature

Contrats associés