Interface PolicyConfig<Args, Result, This>

Complete, closed policy configuration accepted by definePolicy.

This has a default so configurations can be named independently from a particular receiver type, while definePolicy still preserves it.

interface PolicyConfig<Args extends readonly unknown[], Result, This = unknown> {
    fallback?: false | Readonly<FallbackPolicyOptions<Args, Result>>;
    circuitBreaker?: false | Readonly<CircuitBreakerPolicyOptions<This, Args>>;
    retry?: false | Readonly<RetryPolicyOptions<This, Args>>;
    timeout?: false | Readonly<TimeoutPolicyOptions>;
    order?: PolicyOrder;
}

Type Parameters

Args extends readonly unknown[]
Result
This = unknown

Index

Properties

fallback? circuitBreaker? retry? timeout? order?

Properties

`Optional` `Readonly`fallback

fallback?: false | Readonly<FallbackPolicyOptions<Args, Result>>

`Optional` `Readonly`circuitBreaker

circuitBreaker?: false | Readonly<CircuitBreakerPolicyOptions<This, Args>>

`Optional` `Readonly`retry

retry?: false | Readonly<RetryPolicyOptions<This, Args>>

`Optional` `Readonly`timeout

timeout?: false | Readonly<TimeoutPolicyOptions>

`Optional` `Readonly`order

order?: PolicyOrder