Documentation / @zerotal/client / index / CircuitBreaker

Class: CircuitBreaker

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

A three-state circuit breaker that wraps async operations.

State	Behaviour
`closed`	Requests pass through; consecutive failures are counted.
`open`	All calls immediately throw `CircuitBreakerOpenError`.
`half-open`	One probe request is allowed through to test recovery.

State transitions:

closed → open when failure count reaches threshold
open → half-open after resetTimeout ms have elapsed
half-open → closed on a successful probe
half-open → open on a failed probe (resets the timeout)

Example

const breaker = new CircuitBreaker({ threshold: 3, resetTimeout: 10_000 });

const client = createApiClient({
  baseUrl: 'https://api.example.com',
  circuitBreaker: breaker,
});