Graphorin API reference v0.15.1
Graphorin API reference / @graphorin/server / / IdempotencyMiddlewareOptions
Interface: IdempotencyMiddlewareOptions
Defined in: packages/server/src/middleware/idempotency.ts:44
Stable
Options accepted by createIdempotencyMiddleware.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
config | readonly | { checkBodyFingerprint: boolean; enabled: boolean; lruCacheSize: number; requireKey: IdempotencyRequireKeyMode; ttlSeconds: number; } | - | packages/server/src/middleware/idempotency.ts:53 |
config.checkBodyFingerprint | readonly | boolean | - | packages/server/src/config.ts:82 |
config.enabled | readonly | boolean | - | packages/server/src/config.ts:79 |
config.lruCacheSize | readonly | number | - | packages/server/src/config.ts:83 |
config.requireKey | readonly | IdempotencyRequireKeyMode | - | packages/server/src/config.ts:80 |
config.ttlSeconds | readonly | number | - | packages/server/src/config.ts:81 |
excludeResponseCachePaths? | readonly | readonly string[] | Paths whose responses are NEVER cached or replayed - the middleware passes straight through. Used for secret-bearing endpoints (POST /v1/tokens returns a raw token; caching it would persist the secret plaintext in durable SQLite for the TTL). | packages/server/src/middleware/idempotency.ts:51 |
metricRegistry? | readonly | MetricRegistry | When supplied, the middleware publishes a live graphorin_idempotency_cache_hit_ratio gauge (replays / replays+executes) instead of leaving the registered metric a permanently-empty series. | packages/server/src/middleware/idempotency.ts:61 |
now? | readonly | () => number | Wall-clock provider; tests inject a deterministic generator. | packages/server/src/middleware/idempotency.ts:55 |
store | readonly | IdempotencyStore | - | packages/server/src/middleware/idempotency.ts:52 |