Documentation / @zerotal/client / index / CircuitBreakerOptions

Interface: CircuitBreakerOptions

Defined in: client/src/CircuitBreaker.ts:8

Properties

threshold?

optional threshold?: number

Defined in: client/src/CircuitBreaker.ts:13

Number of consecutive failures required to open the circuit. Default: 5.

resetTimeout?

optional resetTimeout?: number

Defined in: client/src/CircuitBreaker.ts:18

Milliseconds to wait in the open state before allowing a single probe request through (transition to half-open). Default: 30_000 (30 s).

isFailure?

optional isFailure?: (error) => boolean

Defined in: client/src/CircuitBreaker.ts:25

Predicate that decides whether a thrown error counts as a failure. By default, network errors and ApiClientError responses with status ≥ 500 are failures; 4xx errors are not (they indicate client mistakes, not upstream outages).

Parameters

error

unknown

Returns

boolean