Class ResiliencePolicy<TConfig, TRule, S, H, P>`Abstract`

Abstract base class for resilience policies.

Provides the common three-method pattern used by all policies:

init: Parse config, initialize state (O(1))
resolve: Memoized lookup + dynamic checks (O(1) amortized)
compute: Rule matching, memoized (O(n) first call only)

Subclasses must implement:

getDefaultSerializer(): Return the default serializer for this policy
getDefaultMethods(): Return the default HTTP methods for this policy
mergeRuleWithDefaults(rule): Merge a rule with policy defaults

Type Parameters

TConfig extends BasePolicyConfig<any, any, any, TRule>
The policy config type extending BasePolicyConfig
TRule extends BasePolicyRule<any, any, any>
The rule type extending BasePolicyRule
S = any
Instance state type
H = any
Headers type
P = any
Params type

Hierarchy (View Summary)

ResiliencePolicy

Index

Constructors

Properties

Accessors

Methods

clearCache compute getDefaultMethods getDefaultSerializer init mergeRuleWithDefaults resolve

Constructors

constructor

new ResiliencePolicy<
    TConfig extends BasePolicyConfig<any, any, any, TRule>,
    TRule extends BasePolicyRule<any, any, any>,
    S = any,
    H = any,
    P = any,
>(): ResiliencePolicy<TConfig, TRule, S, H, P>
Type Parameters
- TConfig extends BasePolicyConfig<any, any, any, TRule>
  The policy config type extending BasePolicyConfig
- TRule extends BasePolicyRule<any, any, any>
  The rule type extending BasePolicyRule
- S = any
  Instance state type
- H = any
  Headers type
- P = any
  Params type
Returns ResiliencePolicy<TConfig, TRule, S, H, P>

Properties

`Protected`config

config: TConfig | null = null

`Protected`state

state: PolicyInternalState<TRule, S, H, P> | null = null

Accessors

isEnabled

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

Returns boolean
- Defined in packages/fetch/src/plugins/base.ts:71

Methods

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
- Defined in packages/fetch/src/plugins/base.ts:228

`Protected`compute

compute(method: string, path: string): TRule | 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 TRule | null
Computed rule or null if disabled
- Defined in packages/fetch/src/plugins/base.ts:180

`Protected` `Abstract`getDefaultMethods

getDefaultMethods(): _InternalHttpMethods[]
Get the default HTTP methods for this policy. Subclasses must implement this.

Returns _InternalHttpMethods[]
- Defined in packages/fetch/src/plugins/base.ts:56

`Protected` `Abstract`getDefaultSerializer

getDefaultSerializer(): RequestSerializer<S, H, P>
Get the default serializer for this policy. Subclasses must implement this.

Returns RequestSerializer<S, H, P>
- Defined in packages/fetch/src/plugins/base.ts:50

init

init(config?: boolean | TConfig): void
Initialize the policy with configuration.

Parses the config (boolean or object), validates rules, and sets up internal state for fast lookups.
Parameters
- Optionalconfig: boolean | TConfig
  Boolean true for defaults, or full config object
Returns void
- Defined in packages/fetch/src/plugins/base.ts:85

`Protected` `Abstract`mergeRuleWithDefaults

mergeRuleWithDefaults(rule: TRule | null): TRule
Merge a matched rule with policy defaults. Subclasses must implement this to handle policy-specific fields.
Parameters
- rule: TRule | null
  The matched rule (or null for global defaults)
Returns TRule
The merged rule with all defaults applied
- Defined in packages/fetch/src/plugins/base.ts:65

resolve

resolve(
    method: string,
    path: string,
    ctx: RequestKeyOptions<S, H, P>,
    skipCallback?: (ctx: RequestKeyOptions<S, H, P>) => boolean | undefined,
): TRule | 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 TRule | null
Resolved rule or null if disabled
- Defined in packages/fetch/src/plugins/base.ts:134