Sanity Library Reference Docs
    Preparing search index...

    Which entries make a heartbeat drain an instance: the ones no drainer is working on, such as an effect queued before its drain function existed, one queued while the drain was down, or one left under a lapsed claim.

    interface HeartbeatCatchUpSpec {
        afterMs: number;
        budgetedEffectNames: string[];
        effectNames: string[];
        limits: FunctionLimits;
        recoverDefinitions: string[];
    }
    Index

    Properties

    afterMs: number

    How long an entry must have been pending and never claimed to be caught up, in milliseconds: one beat of HeartbeatSpec.schedule. A lapsed claim counts whatever the entry's age.

    budgetedEffectNames: string[]

    The entries in effectNames that declare their own budget, name ascending. A beat runs at most one of them.

    effectNames: string[]

    Every 'function'-hosted effect in the deployment, name ascending. Non-empty.

    The budget the emitted beat carries: for each field some effect declares, the larger of the platform default and the largest declared value. Empty when none of them declares one.

    recoverDefinitions: string[]

    The definitions whose instances the beat recovers, name ascending: every workflow declaring one of effectNames, whatever kind hosts the workflow itself. Non-empty, and separate from the definitions the beat ticks.