Sanity Library Reference Docs
    Preparing search index...

    Args for Engine.drainEffects — the drainer's identity is the engine client's token, like every other verb.

    interface DrainEffectsArgs {
        instanceId: string;
        names?: readonly string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    Properties

    instanceId: string
    names?: readonly string[]

    Restrict to specific effect names. At least one name; an empty list throws. Omitted considers every claimable entry, including ones no handler covers, which missingHandler then decides.