Beignet API reference
    Preparing search index...

    Interface IdempotencyReserveInput

    Input for reserving an idempotency key.

    interface IdempotencyReserveInput {
        fingerprint: string;
        key: string;
        namespace: string;
        reservationTtlSec?: number;
        scope?: IdempotencyScope;
        ttlSec?: number;
    }

    Hierarchy (View Summary)

    Index
    fingerprint key namespace reservationTtlSec? scope? ttlSec?
    fingerprint: string

    Fingerprint of the logical command payload.

    key: string

    Client-provided idempotency key.

    namespace: string

    Operation namespace, usually a use-case or route name.

    reservationTtlSec?: number

    Time-to-live for unfinished work before a successor may reserve the key.

    300
    scope?: IdempotencyScope

    Logical scope for this key.

    ttlSec?: number

    Optional time-to-live for the completed replay result.

    Settings
    Member Visibility

    On This Page
    Properties