Sanity Library Reference Docs
    Preparing search index...
    interface DrainEffectsResult {
        definitionContentHash?: string;
        drained: PendingEffect[];
        failed: PendingEffect[];
        lost: PendingEffect[];
        skipped: PendingEffect[];
    }
    Index

    Properties

    definitionContentHash?: string

    The drained instance's pinned definition fingerprint — carried so the drain telemetry event can slice per definition. Absent only for instances pinned before content fingerprinting.

    drained: PendingEffect[]
    failed: PendingEffect[]

    Entries this drainer dispatched without settling. Either another party settled the entry first (a lease-expiry takeover, a manual recovery, or a completion landing while a retry run waited out a backoff), or a retry run stopped because the claim could no longer be held, which leaves the entry pending for a later drain. The handler's side effect ran here too: the at-least-once overlap the EffectHandler contract tells handlers to tolerate.

    skipped: PendingEffect[]