Skip to content
Français

WorkflowGateOptions

import type { WorkflowGateOptions } from "@elie-laloum/outpost";
  • authenticationOptional
    "signed" | undefined
    Set to signed to require a verified Ed25519 proof on every decision for this gate. Stored in the gate and in checkpoint identity.
  • keyRequired
    string
    Task key of the gate, unique in the workflow and named by each decision. Letters, digits, dot, underscore and hyphen, starting with a letter or digit.
  • afterOptional
    readonly Task<unknown>[] | undefined
    Tasks that must be done before the gate pauses. If one fails or is skipped, cancelled or rejected, the gate is skipped.
  • promptRequired
    string
    Question put to the actors, copied into the pending request. A blank prompt throws.
  • actorsRequired
    readonly string[]
    Names allowed to decide the gate: at least one, unique and nonblank. Outpost trusts the actor your application submits unless the gate is signed.
export interface WorkflowGateOptions {
  readonly authentication?: "signed";
  readonly key: string;
  readonly after?: readonly Task[];
  readonly prompt: string;
  readonly actors: readonly string[];
}