Interface CircuitBreakerConfig

interface CircuitBreakerConfig {
    halfOpenAfter: number;
    methods?: string[];
    openAfterFailedAttempts: number;
    statusCodes?: number[];
    triggerOnNetworkError?: boolean;
    triggerOnTimeout?: boolean;
}

Properties

halfOpenAfter methods? openAfterFailedAttempts statusCodes? triggerOnNetworkError? triggerOnTimeout?

Properties

halfOpenAfter

halfOpenAfter: number

How long to wait before sending a request again after the circuit breaker opened.

Optionalmethods

methods?: string[]

HTTP methods considered for opening the circuit breaker. Note that all requests will be blocked, once the circuit breaker is open. Default: all

openAfterFailedAttempts

openAfterFailedAttempts: number

OptionalstatusCodes

statusCodes?: number[]

HTTP status codes that are counted as failed attempts for the circuit breaker. Default: [408, 420, 429, 500, 502, 503, 504]

OptionaltriggerOnNetworkError

triggerOnNetworkError?: boolean

Default: true

OptionaltriggerOnTimeout

triggerOnTimeout?: boolean

Default: true

Settings

Member Visibility

On This Page

Properties