footprintjs - v11.2.0
    Preparing search index...

    Interface ExecutionEnv

    ExecutionEnv — infrastructure values that propagate through nested executors.

    Like process.env for flowcharts: read-only, inherited by child executors, infrastructure-only (not business logic).

    Litmus test: Created external to the flowchart + passed in for execution = env. Business config for a specific flowchart = args (getArgs()).

    Intentionally a closed type — not extensible to prevent coupling between parent and child flowcharts.

    interface ExecutionEnv {
        deadline?: number;
        operationId?: string;
        signal?: AbortSignal;
        timeoutMs?: number;
        traceId?: string;
        traceparent?: string;
    }
    Index
    deadline?: number

    The run's deadline, epoch milliseconds (10.1) — the earliest of RunOptions.deadline, now + RunOptions.timeoutMs and a deadline given here. The run's signal aborts when it passes; every attempt is capped by the time left. Inherited by subflows. Read it through scope.$attempt().timeLeftMs().

    operationId?: string

    The caller's unit of work (W3C's parent-id) — part of the run's RunCorrelation; wins over the header's parent-id. Needs a trace: traceId or traceparent (refused alone). Same character rule as traceId.

    signal?: AbortSignal

    AbortSignal for cooperative cancellation across nested executors. Honoured by the engine (10.1): it ends the run like RunOptions.signal. Under a run that has a signal or a deadline AND an env, a stage reads the run's ONE effective signal here — RunOptions.signal, this one and the deadline's timer, composed.

    timeoutMs?: number

    Timeout budget in milliseconds. Readable only — the run's deadline is deadline.

    traceId?: string

    Trace identifier for distributed tracing / observability. With operationId (or alone) it becomes the run's RunCorrelation; it wins over the trace id of traceparent. 1–256 printable ASCII characters with no space (since 10.1 anything else rejects the run with a TypeError naming the field — the id rides every event); an empty string is no id.

    traceparent?: string

    A W3C traceparent header, usually straight from an inbound request. Parsed STRICTLY once per run — a malformed one refuses the run with a TraceparentError naming the reason (never the header). Stages read back ($getEnv()) exactly RunCorrelation.traceparent — the canonical header of the effective ids — or no key when the run's correlation carries none. Correlation only: never identity or authorisation.