Sanity Library Reference Docs
    Preparing search index...
    interface HeartbeatResult {
        caughtUp: number;
        caughtUpUnsettled: number;
        changed: number;
        deferred: number;
        failed: number;
        released: number;
        total: number;
    }
    Index

    Properties

    caughtUp: number

    Pending effects the catch-up drain settled successfully.

    caughtUpUnsettled: number

    Pending effects the catch-up drain settled as failed, or dispatched without settling because another party settled them first. Each one is logged at error level with its instance.

    changed: number
    deferred: number

    Instances whose budgeted dispatch this beat withheld, because another instance had already taken its one run of HeartbeatCatchUpArgs.budgetedEffect. Their unbudgeted entries are drained all the same, and a later beat takes the budgeted one.

    failed: number

    Instances whose sweep, catch-up or tick threw. A failed effect does not throw, so it is counted above instead.

    released: number

    Stale effect claims the sweep released.

    total: number

    Instances this pass worked on: every in-flight instance of definitions, plus every instance of HeartbeatCatchUpArgs.recoverDefinitions holding an entry the catch-up looked for, completed ones included.