CacheConfig

Defined in: packages/gateway/src/policies/traffic/cache.ts:155

Configuration for the cache policy.

Extends

PolicyConfig

Properties

bypassDirectives?

optional bypassDirectives?: string[]

Defined in: packages/gateway/src/policies/traffic/cache.ts:173

Cache-Control directives that trigger a bypass. Matched at the directive level, not substring. Default: ["no-store", "no-cache"].

cacheableStatuses?

optional cacheableStatuses?: number[]

Defined in: packages/gateway/src/policies/traffic/cache.ts:163

Only cache responses with these status codes. When set, responses with other statuses are not cached (5xx is always excluded regardless).

cacheKeyFn?

optional cacheKeyFn?: (c) => string | Promise<string>

Defined in: packages/gateway/src/policies/traffic/cache.ts:161

Custom cache key builder. Supports async for body-based keys. Default: method + url (+ body hash for POST/PUT/PATCH).

Parameters

c

Context

Returns

string | Promise<string>

cacheStatusHeader?

optional cacheStatusHeader?: string

Defined in: packages/gateway/src/policies/traffic/cache.ts:171

Response header name for cache status (HIT/MISS/BYPASS/SKIP). Default: "x-cache".

methods?

optional methods?: string[]

Defined in: packages/gateway/src/policies/traffic/cache.ts:159

HTTP methods to cache. Default: [“GET”]. Case-insensitive.

respectCacheControl?

optional respectCacheControl?: boolean

Defined in: packages/gateway/src/policies/traffic/cache.ts:169

Respect upstream Cache-Control directives. Default: true.

skip?

optional skip?: (c) => boolean | Promise<boolean>

Defined in: packages/gateway/src/policies/types.ts:90

Skip this policy when condition returns true

Parameters

c

unknown

Returns

boolean | Promise<boolean>

Inherited from

PolicyConfig.skip

store?

optional store?: CacheStore

Defined in: packages/gateway/src/policies/traffic/cache.ts:167

Storage backend. Default: InMemoryCacheStore.

ttlSeconds?

optional ttlSeconds?: number

Defined in: packages/gateway/src/policies/traffic/cache.ts:157

Cache TTL in seconds. Default: 300.

varyHeaders?

optional varyHeaders?: string[]

Defined in: packages/gateway/src/policies/traffic/cache.ts:165

Vary cache key on these request headers.