Interface BasePolicyConfig<S, H, P, TRule>

Base interface for all policy configurations.

Provides common fields shared across all resilience policy configs (dedupe, cache, rate-limit, retry).

interface BasePolicyConfig<
    S = unknown,
    H = unknown,
    P = unknown,
    TRule extends BasePolicyRule<S, H, P> = BasePolicyRule<S, H, P>,
> {
    enabled?: boolean;
    methods?: _InternalHttpMethods[];
    rules?: TRule[];
    serializer?: RequestSerializer<S, H, P>;
}

Type Parameters

S = unknown
Instance state type
H = unknown
Headers type
P = unknown
Params type
TRule extends BasePolicyRule<S, H, P> = BasePolicyRule<S, H, P>
The specific rule type that extends BasePolicyRule

Index

Properties

enabled? methods? rules? serializer?

Properties

`Optional`enabled

enabled?: boolean

Enable policy globally

`Optional`methods

methods?: _InternalHttpMethods[]

HTTP methods to apply by default

`Optional`rules

rules?: TRule[]

Route-specific rules

`Optional`serializer

serializer?: RequestSerializer<S, H, P>

Default serializer for key generation