Skip to content
Français

WorkflowJobStartOptions

import type { WorkflowJobStartOptions } from "@elie-laloum/outpost";
  • observationOptional
    ObservationHub | undefined
    Parent hub receiving workflow, task, agent and operation envelopes; historical observe callbacks still receive WorkflowEvent.
  • timeoutMsOptional
    number | undefined
    Deadline in milliseconds for this start() call, a positive integer up to 2147483647, covering checkpoint acquisition, conditions, attempts and retry waits. Expiry cancels running tasks and the status is failed with an OutpostError code timeout; each call gets a fresh deadline.
  • onQuotaOptional
    WorkflowQuotaPolicy | undefined
    Opt-in policy that pauses a task on a quota error instead of retrying or failing it; requires a checkpoint. Quota pauses release on a later start() once the reset is known to be reachable within maxWaitMs, or when it is unknown or past.
  • decisionVerifierOptional
    WorkflowDecisionVerifier | undefined
    Trusted verifier invoked for each submitted proof; required to accept decisions on signed gates. Verification failures leave all pending decisions unapplied.
  • concurrencyOptional
    number | undefined
    Maximum tasks running at once, default 1 (tasks run in list order). Must be a positive integer.
  • budgetOptional
    WorkflowBudget | undefined
    Attempt and token limits shared by every task, including restored usage; reaching one fails the run with WorkflowBudgetExceeded.
  • stopOnErrorOptional
    boolean | undefined
    Defaults to true: the first failure aborts the run, cancelling running and pending tasks. With false, only dependents of the failed task are skipped and independent tasks continue.
  • telemetryOptional
    WorkflowTelemetry | undefined
    Adapter that receives each WorkflowEvent before observe, such as createOpenTelemetryObserver({ tracer, meter }). Its errors go to observerErrors; you own its lifecycle.
  • observeOptional
    ((event: WorkflowEvent) => void) | undefined
    Receives each WorkflowEvent after telemetry; thrown errors are collected in observerErrors without changing the run.
export type WorkflowJobStartOptions = Omit<
  WorkflowOptions,
  "checkpoint" | "signal" | "decisions" | "answers"
>;