footprintjs - v11.2.0
    Preparing search index...

    Interface IdempotencyKeyContext

    What a stage's idempotency-key rule is handed — once per EXECUTION, before attempt 1 (StageTouches).

    interface IdempotencyKeyContext {
        args: unknown;
        runId: string;
        runtimeStageId: string;
        getState(key: string): unknown;
    }
    Index
    args runId runtimeStageId
    getState
    args: unknown

    The run's (or the subflow's) input, frozen. On the root of a resumed leg the run's input is gone (it does not cross a resume), so reading it there THROWS rather than hand the rule nothing — the stage fails before anything is sent. A paused stage itself resumes under the key its checkpoint carries; the rule is not asked again.

    runId: string

    This run's id. Regenerated per run and per resume — never a key on its own (see StageTouches).

    runtimeStageId: string

    The execution the key is for (charge#4).

    • A committed state value, read without tracking — the key is not a write. Use it for a key the chart keeps in state; it survives a resume, where args does not (reading args on a resumed leg's root throws). A selected value read here makes the recorded key the redaction placeholder. Read-only: a frozen copy, never the committed value itself.

      Parameters

      • key: string

      Returns unknown

    Settings
    Member Visibility

    On This Page
    Properties
    Methods