Aller au contenu
English

definePauseTask

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

Définit une tâche gate qui retient l’exécution une fois ses dépendances terminées jusqu’à ce qu’un acteur autorisé soumette resume ou reject. Elle prend les mêmes options et validations que defineApprovalTask() ; resume fait du WorkflowDecisionRecord la valeur de la gate.

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

  • optionsRequis
    WorkflowGateOptions
    Clé de la gate, dépendances, prompt, acteurs autorisés à reprendre ou rejeter, et l’authentification signed facultative.
  • options.authenticationOptionnel
    "signed" | undefined
    signed exige une preuve Ed25519 vérifiée sur chaque décision de cette gate. Enregistré dans la gate et dans l’identité du checkpoint.
  • options.keyRequis
    string
    Clé de tâche de la gate, unique dans le workflow et reprise par chaque décision. Lettres, chiffres, point, tiret bas et tiret, en commençant par une lettre ou un chiffre.
  • options.afterOptionnel
    readonly Task<unknown>[] | undefined
    Tâches qui doivent être terminées avant que la gate se suspende. Si l’une échoue ou est ignorée, annulée ou rejetée, la gate est ignorée.
  • options.promptRequis
    string
    Question posée aux acteurs, copiée dans la demande en attente. Un prompt vide lève une erreur.
  • options.actorsRequis
    readonly string[]
    Noms autorisés à décider la gate : au moins un, uniques et non vides. Outpost fait confiance à l’acteur soumis par votre application, sauf si la gate est signée.

Task<WorkflowDecisionRecord>

export declare function definePauseTask(
  options: WorkflowGateOptions,
): Task<WorkflowDecisionRecord>;