CircuitBreakerSettings
Defined in: src/pattern/CircuitBreaker.ts:3
Properties
Section titled “Properties”callTimeoutMs?
Section titled “callTimeoutMs?”
readonlyoptionalcallTimeoutMs?:number
Defined in: src/pattern/CircuitBreaker.ts:9
Per-call timeout; exceeding this counts as a failure.
isFailure?
Section titled “isFailure?”
readonlyoptionalisFailure?: (err) =>boolean
Defined in: src/pattern/CircuitBreaker.ts:11
Optional: classify errors as non-failures to bypass breaker counting.
Parameters
Section titled “Parameters”Error
Returns
Section titled “Returns”boolean
maxFailures
Section titled “maxFailures”
readonlymaxFailures:number
Defined in: src/pattern/CircuitBreaker.ts:5
Consecutive failures before the breaker opens. Must be >= 1.
resetTimeoutMs
Section titled “resetTimeoutMs”
readonlyresetTimeoutMs:number
Defined in: src/pattern/CircuitBreaker.ts:7
How long the breaker stays open before letting a probe through. ms.