defineCommandTask

Rôle et comportement

Déclare une tâche qui exécute une commande dans une sandbox que vous avez ouverte et gardez ouverte ; command peut être une fabrique qui lit les valeurs des dépendances. Un statut de sortie non nul fait échouer la tentative avec une OutpostError de code process, et retry s’applique. La sortie est le CommandResult.

Exemple complet et règles détaillées.

Paramètres et propriétés

• optionsRequis
  Omit<TaskOptions<CommandResult>, "perform"> & CommandTaskOptions
  Réglages d’ordonnancement, sandbox existante et commande ou fabrique de commande.
• options.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.
• options.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.
• options.gateOptionnel
  WorkflowGate | undefined
  Définition persistée d’approbation ou pause ; son exécution exige un checkpoint et une décision de confiance correspondante.
• options.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.
• options.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().
• options.interactionOptionnel
  TaskInteraction | undefined
  Contrat optionnel de saisie humaine durable ; exige un checkpoint et ne peut pas être combiné avec une gate.
• options.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.
• options.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.
• options.sandboxRequis
  Sandbox
  Sandbox existante appartenant à l’appelant et réutilisée par la tâche ; la tâche ne la ferme pas.
• options.commandRequis
  Command | ((context: TaskContext) => Command)
  Commande à exécuter, ou fabrique la construisant depuis les valeurs des dépendances.

Retour

Task<CommandResult>

Signature

export declare function defineCommandTask(
  options: Omit<TaskOptions<CommandResult>, "perform"> & CommandTaskOptions,
): Task<CommandResult>;

Contrats associés

• CommandResult
• CommandTaskOptions
• Task
• TaskOptions