bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface StepRecord

    Record of a step's execution

    interface StepRecord {
        attempts?: number;
        childExecutionId?: string;
        compensatable?: boolean;
        compensation?: CompensationOutcome;
        completedAt?: number;
        error?: string;
        idempotencyKey?: string;
        loopIndex?: number;
        loopItem?: unknown;
        occurrence?: number;
        result?: unknown;
        startedAt?: number;
        status: StepState;
    }
    Index
    attempts? childExecutionId? compensatable? compensation? completedAt? error? idempotencyKey? loopIndex? loopItem? occurrence? result? startedAt? status
    attempts?: number
    childExecutionId?: string

    Child execution owned by a sub-workflow record.

    compensatable?: boolean

    Whether this step declared a compensate handler when it ran. This survives a deployment that removes or renames the definition.

    compensation?: CompensationOutcome

    Exactly one terminal compensation outcome for every eligible step.

    completedAt?: number
    error?: string
    idempotencyKey?: string

    Idempotency key of the forward execution, persisted before the body runs.

    loopIndex?: number

    forEach iteration index — persisted so compensation can restore __index

    loopItem?: unknown

    forEach iteration item — persisted so compensation can restore __item

    occurrence?: number

    Occurrence of this step name within the run — loops reuse a single name.

    result?: unknown
    startedAt?: number
    status: StepState

    Settings
    Member Visibility

    On This Page
    Properties