Sanity Library Reference Docs
    Preparing search index...

    Interface EffectHistoryEntry

    interface EffectHistoryEntry {
        _key: string;
        actor?: Actor;
        description?: string;
        detail?: string;
        durationMs?: number;
        error?: { message: string; stack?: string };
        name: string;
        origin: EffectOrigin;
        outputs?: Record<string, unknown>;
        params: Record<string, unknown>;
        ranAt: string;
        stageEntryKey?: string;
        status: EffectRunStatus;
        title?: string;
    }
    Index

    Properties

    _key actor? description? detail? durationMs? error? name origin outputs? params ranAt stageEntryKey? status title?

    Properties

    _key

    _key: string
    actor?: Actor
    description?: string
    detail?: string
    durationMs?: number
    error?: { message: string; stack?: string }
    name: string
    origin: EffectOrigin
    outputs?: Record<string, unknown>

    Outputs the runtime reported back — the source the $effects read derives from ($effects['<effect name>'].<output> is the latest completed run's outputs, by name). Recorded here for audit.

    params: Record<string, unknown>
    ranAt: string
    stageEntryKey?: string

    _key of the stage entry the run was queued under, carried from the pending entry — the identity that makes the $effectStatus read re-entry-safe (a timestamp tie could not be: same-commit loop-backs and frozen test clocks stamp identical times). Absent only on rows persisted before the engine stamped it; those never count as the current entry's run (fail closed).

    status: EffectRunStatus
    title?: string

    Settings

    Member Visibility

    On This Page

    Properties