API Reference

---

API Reference / CircuitBreaker

Class: CircuitBreaker

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

Per-endpoint-tier failures are expected (a bad order, a 4xx) and must not trip this — only sustained transport/server failures should stop new requests from going out.

Constructors

Constructor

new CircuitBreaker(options?): CircuitBreaker

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

Parameters

options?

CircuitBreakerOptions = {}

Returns

CircuitBreaker

Methods

getState()

getState(): CircuitState

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

Returns

CircuitState

---

execute()

execute<T>(fn): Promise<T>

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

Type Parameters

T

T

Parameters

fn

() => Promise<T>

Returns

Promise<T>