Libraries v5.0.0
    Preparing search index...

    Interface ServerIdempotencyOptions

    Configuration for bounded, process-local mutation response replay.

    interface ServerIdempotencyOptions {
        headerName?: string;
        maxEntries?: number;
        maxResponseBytes?: number;
        scope: (ctx: RequestContext) => string | undefined;
        skip?: (ctx: RequestContext) => boolean;
        ttl?: number;
    }
    Index
    headerName? maxEntries? maxResponseBytes? scope skip? ttl?
    headerName?: string

    Case-insensitive request header. Default: x-idempotency-key.

    maxEntries?: number

    Maximum retained keys, including pending requests. Default: 1000.

    maxResponseBytes?: number

    Maximum response body retained per key. Default: 65,536 bytes.

    scope: (ctx: RequestContext) => string | undefined

    Explicit authorization/tenant scope. Run after authentication and authorization. Return undefined to skip; use a fixed string only for deliberately public operations. Never use an unverified identity header.

    skip?: (ctx: RequestContext) => boolean

    Default: skip GET, HEAD, OPTIONS and other non-mutating methods.

    ttl?: number

    Stored response lifetime in milliseconds. Default: 86,400,000.

    Settings
    Member Visibility

    On This Page
    Properties