Interface CircuitBreakerConfig

interface CircuitBreakerConfig {
    name: string;
    failureThreshold: number;
    failureWindowMs: number;
    cooldownMs: number;
    halfOpenSuccessThreshold: number;
    onStateChange?: ((from, to, name) => void);
}

Properties

name failureThreshold failureWindowMs cooldownMs halfOpenSuccessThreshold onStateChange?

Properties

name

name: string

Unique name for this breaker (for logging/metrics).

failureThreshold

failureThreshold: number

Number of failures before opening the circuit.

Default

5

failureWindowMs

failureWindowMs: number

Time window in ms to count failures.

Default

60000

cooldownMs

cooldownMs: number

How long to stay open before trying half-open.

Default

30000

halfOpenSuccessThreshold

halfOpenSuccessThreshold: number

Number of successful probes in half-open before closing.

Default

2

Optional onStateChange

onStateChange?: ((from, to, name) => void)

Optional callback when state transitions.

Type declaration

Settings

Member Visibility

Theme

On This Page

namefailureThresholdfailureWindowMscooldownMshalfOpenSuccessThresholdonStateChange