Sanity Library Reference Docs
    Preparing search index...

    Interface HeartbeatSpec

    The emitted scheduled heartbeat. It ticks only instances of the 'function'-hosted workflows named in definitions, and never ticks a durable or self-hosted workflow's instances. It recovers the queues of the workflows HeartbeatCatchUpSpec.recoverDefinitions names, whatever kind hosts them.

    reasons is non-empty: a condition reading the clock or a spawning action on a ticked workflow, or a 'function'-hosted effect anywhere in the deployment. A deployment with none of those emits no heartbeat at all.

    interface HeartbeatSpec {
        catchUp?: HeartbeatCatchUpSpec;
        definitions: string[];
        name: string;
        reasons: string[];
        schedule: string;
    }
    Index

    Properties

    catchUp? definitions name reasons schedule

    Properties

    catchUp?: HeartbeatCatchUpSpec

    Absent when no effect in the deployment is 'function'-hosted, so the beat has nothing to catch up. Present, its HeartbeatCatchUpSpec.limits are the emitted function's budget.

    definitions: string[]

    The definition names the beat ticks, name ascending. Empty when the deployment hosts no workflow on 'function' and the beat exists only to recover queues.

    name: string
    reasons: string[]
    schedule: string

    Settings

    Member Visibility

    On This Page

    Properties