Interface ServerIdempotencyOptions

Configuration for idempotency.

interface ServerIdempotencyOptions {
    headerName?: string;
    skip?: (ctx: RequestContext) => boolean;
    ttl?: number;
}

Properties

headerName?: string

Header name to read the idempotency key from. Defaults to "x-idempotency-key".

skip?: (ctx: RequestContext) => boolean

Predicate that decides whether a request should be skipped. Defaults to skipping non-mutating requests (GET, HEAD, OPTIONS).

ttl?: number

TTL in milliseconds for stored responses. Defaults to 86_400_000 (24 hours).