Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowEffectsDrainedData

    The caller-provenance fields every engine event payload carries: the engine's own view of the host that invoked it. ExecutionContext.id is never reported.

    interface WorkflowEffectsDrainedData {
        definitionContentHash?: string;
        drainedCount: number;
        drainedEffects: string[];
        executionKind?: ReportedExecutionKind;
        executionRuntime: string;
        instanceId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    definitionContentHash? drainedCount drainedEffects executionKind? executionRuntime instanceId

    Properties

    definitionContentHash?: string

    Absent only when the definition predates content fingerprinting.

    drainedCount: number

    Pending effects dispatched to a registered handler in this drain — 0 for an empty poll (the pass itself is the signal).

    drainedEffects: string[]

    The dispatched effects' author-chosen names, in drain order.

    executionKind?: ReportedExecutionKind

    Where the operation came from: the host's declared EXECUTION_KINDS value projected onto the reported vocabulary, or other for a kind outside it. Absent when the host declared none.

    executionRuntime: string

    The JavaScript runtime the engine inferred for itself, matching the executionContext.runtime the same operation stamps on its history entries.

    instanceId: string

    The instance document _id — the per-instance join key (engine-minted <tag>.wf-instance.<random>; caller-supplied ids ride verbatim).

    Settings

    Member Visibility

    On This Page

    Properties