Beignet API reference
    Preparing search index...

    Interface IdempotencyMeta

    Contract metadata for idempotency-aware routes.

    This metadata is enforced at the HTTP boundary by createIdempotencyHooks(...) from @beignet/core/server. runIdempotently(...) remains the primitive for non-HTTP workflows such as jobs, listeners, webhooks, and schedules.

    interface IdempotencyMeta {
        header?: string;
        required?: boolean;
        reservationTtlSec?: number;
        scope?: IdempotencyScopeMode;
        ttlSec?: number;
    }
    Index
    header? required? reservationTtlSec? scope? ttlSec?
    header?: string

    Header that carries the idempotency key.

    Default: "idempotency-key".

    required?: boolean

    Whether this operation requires an idempotency key at the HTTP boundary.

    reservationTtlSec?: number

    Time-to-live for unfinished reservations.

    300
    scope?: IdempotencyScopeMode

    How to scope idempotency keys when an HTTP hook derives the scope.

    By default the HTTP hook scopes to the actor and includes the tenant when one is present. Use "global" explicitly only when every caller should share one idempotency-key namespace for the operation.

    ttlSec?: number

    Time-to-live for completed replay results.

    Settings
    Member Visibility

    On This Page
    Properties