Class CachePolicy<S, H, P>

Cache policy for storing and retrieving response data.

Supports stale-while-revalidate (SWR) pattern where stale cached data is returned immediately while fresh data is fetched in the background.

Type Parameters

S = unknown
Instance state type
H = unknown
Headers type
P = unknown
Params type

Hierarchy (View Summary)

ResiliencePolicy<CacheConfig<S, H, P>, CacheRule<S, H, P>, S, H, P>
- CachePolicy

Constructors

constructor

new CachePolicy<S = unknown, H = unknown, P = unknown>(): CachePolicy<S, H, P>
Type Parameters
- S = unknown
  Instance state type
- H = unknown
  Headers type
- P = unknown
  Params type
Returns CachePolicy<S, H, P>
Inherited from ResiliencePolicy.constructor

Properties

`Protected`config

config: CacheConfig<S, H, P> | null = null

`Protected`state

state: CachePolicyState<S, H, P> | null = null

Extended state with cache-specific fields.

Accessors

activeKeys

get activeKeys(): Set<string>
Get active keys set (for SWR tracking).

Returns Set<string>
- Defined in packages/fetch/src/plugins/cache.ts:102

adapter

get adapter(): CacheAdapter<unknown> | undefined
Get the cache adapter (if configured).

Returns CacheAdapter<unknown> | undefined
- Defined in packages/fetch/src/plugins/cache.ts:94

defaultStaleIn

get defaultStaleIn(): number | undefined
Get the default stale time for SWR.

Returns number | undefined
- Defined in packages/fetch/src/plugins/cache.ts:126

defaultTtl

get defaultTtl(): number
Get the default TTL.

Returns number
- Defined in packages/fetch/src/plugins/cache.ts:118

isEnabled

get isEnabled(): boolean
Whether the policy is initialized and enabled.

Returns boolean
Inherited from ResiliencePolicy.isEnabled
- Defined in packages/fetch/src/plugins/base.ts:71

revalidatingKeys

get revalidatingKeys(): Set<string>
Get revalidating keys set (for SWR tracking).

Returns Set<string>
- Defined in packages/fetch/src/plugins/cache.ts:110

Methods

clearActiveKeys

clearActiveKeys(): void
Clear all active keys.

Returns void
- Defined in packages/fetch/src/plugins/cache.ts:279

clearCache

clearCache(): void
Clear the rules cache.

Call this if you need to force re-computation of rules, though typically this is not needed.

Returns void
Inherited from ResiliencePolicy.clearCache
- Defined in packages/fetch/src/plugins/base.ts:228

`Protected`compute

compute(method: string, path: string): CacheRule<S, H, P> | null
Compute rule configuration for a method+path combination.

This is the expensive O(n) operation that gets memoized. Finds matching rule and merges with policy defaults.
Parameters
- method: string
  HTTP method (uppercase)
- path: string
  Request path
Returns CacheRule<S, H, P> | null
Computed rule or null if disabled
Inherited from ResiliencePolicy.compute
- Defined in packages/fetch/src/plugins/base.ts:180

getActiveKeys

getActiveKeys(): string[]
Get all active cache keys.

Returns string[]
- Defined in packages/fetch/src/plugins/cache.ts:287

`Protected`getDefaultMethods

getDefaultMethods(): _InternalHttpMethods[]
Get the default HTTP methods for caching.

Returns _InternalHttpMethods[]
Overrides ResiliencePolicy.getDefaultMethods
- Defined in packages/fetch/src/plugins/cache.ts:142

`Protected`getDefaultSerializer

getDefaultSerializer(): RequestSerializer<S, H, P>
Get the default serializer for caching.

Returns RequestSerializer<S, H, P>
Overrides ResiliencePolicy.getDefaultSerializer
- Defined in packages/fetch/src/plugins/cache.ts:134

init

init(config?: boolean | CacheConfig<S, H, P>): void
Initialize the cache policy with configuration.
Parameters
- Optionalconfig: boolean | CacheConfig<S, H, P>
Returns void
Overrides ResiliencePolicy.init
- Defined in packages/fetch/src/plugins/cache.ts:150

isRevalidating

isRevalidating(key: string): boolean
Check if a key is currently being revalidated.
Parameters
- key: string
Returns boolean
- Defined in packages/fetch/src/plugins/cache.ts:255

markActive

markActive(key: string): void
Mark a key as actively being fetched.
Parameters
- key: string
Returns void
- Defined in packages/fetch/src/plugins/cache.ts:239

markRevalidating

markRevalidating(key: string): void
Mark a key as being revalidated in background.
Parameters
- key: string
Returns void
- Defined in packages/fetch/src/plugins/cache.ts:263

`Protected`mergeRuleWithDefaults

mergeRuleWithDefaults(rule: CacheRule<S, H, P> | null): CacheRule<S, H, P>
Merge a matched rule with policy defaults.
Parameters
- rule: CacheRule<S, H, P> | null
Returns CacheRule<S, H, P>
Overrides ResiliencePolicy.mergeRuleWithDefaults
- Defined in packages/fetch/src/plugins/cache.ts:200

resolve

resolve(
    method: string,
    path: string,
    ctx: RequestKeyOptions<S, H, P>,
    skipCallback?: (ctx: RequestKeyOptions<S, H, P>) => boolean | undefined,
): CacheRule<S, H, P> | null
Resolve policy configuration for a specific request.

Uses memoization for rule matching (O(n) only once per method+path). Skip callbacks are always evaluated since they depend on request context.
Parameters
- method: string
  HTTP method (uppercase)
- path: string
  Request path
- ctx: RequestKeyOptions<S, H, P>
  Full request context for skip callback
- OptionalskipCallback: (ctx: RequestKeyOptions<S, H, P>) => boolean | undefined
  Optional skip callback from config
Returns CacheRule<S, H, P> | null
Resolved rule or null if disabled
Inherited from ResiliencePolicy.resolve
- Defined in packages/fetch/src/plugins/base.ts:134

resolveForRequest

resolveForRequest(
    method: string,
    path: string,
    ctx: RequestKeyOptions<S, H, P>,
): CacheRule<S, H, P> | null
Resolve cache configuration for a request.
Parameters
- method: string
- path: string
- ctx: RequestKeyOptions<S, H, P>
Returns CacheRule<S, H, P> | null
- Defined in packages/fetch/src/plugins/cache.ts:223

unmarkActive

unmarkActive(key: string): void
Unmark a key as actively being fetched.
Parameters
- key: string
Returns void
- Defined in packages/fetch/src/plugins/cache.ts:247

unmarkRevalidating

unmarkRevalidating(key: string): void
Unmark a key as being revalidated.
Parameters
- key: string
Returns void
- Defined in packages/fetch/src/plugins/cache.ts:271

Class CachePolicy<S, H, P>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns CachePolicy<S, H, P>

Properties

Protectedconfig

Protectedstate

Accessors

activeKeys

Returns Set<string>

adapter

Returns CacheAdapter<unknown> | undefined

defaultStaleIn

Returns number | undefined

defaultTtl

Returns number

isEnabled

Returns boolean

revalidatingKeys

Returns Set<string>

Methods

clearActiveKeys

Returns void

clearCache

Returns void

Protectedcompute

Parameters

Returns CacheRule<S, H, P> | null

getActiveKeys

Returns string[]

ProtectedgetDefaultMethods

Returns _InternalHttpMethods[]

ProtectedgetDefaultSerializer

Returns RequestSerializer<S, H, P>

init

Parameters

Returns void

isRevalidating

Parameters

Returns boolean

markActive

Parameters

Returns void

markRevalidating

Parameters

Returns void

ProtectedmergeRuleWithDefaults

Parameters

Returns CacheRule<S, H, P>

resolve

Parameters

Returns CacheRule<S, H, P> | null

resolveForRequest

Parameters

Returns CacheRule<S, H, P> | null

unmarkActive

Parameters

Returns void

unmarkRevalidating

Parameters

Returns void

Settings

On This Page

`Protected`config

`Protected`state

`Protected`compute

`Protected`getDefaultMethods

`Protected`getDefaultSerializer

`Protected`mergeRuleWithDefaults