Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowEffectsDrainedData

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

    Hierarchy

    • InstanceScopedEventData
      • WorkflowEffectsDrainedData
    Index

    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 — one of the payload policy's two deliberate customer-string exceptions (module doc).

    instanceId: string

    The instance document _id — the per-instance join key (engine-minted <tag>.wf-instance.<random>; caller-supplied ids ride verbatim). One of the payload policy's two deliberate customer-string exceptions — see the module doc.