tryError API Documentation v0.0.1-alpha.1

---

tryError API Documentation / CircuitBreaker

Class: CircuitBreaker

Defined in: sync.ts:467

Circuit breaker pattern for synchronous operations

Example

const breaker = createCircuitBreaker({
  failureThreshold: 5,
  resetTimeout: 60000,
});

const result = breaker.execute(() => riskyOperation());

Constructors

Constructor

new CircuitBreaker(options): CircuitBreaker;

Defined in: sync.ts:472

Parameters

options

failureThreshold

number

onClose?

() => void

onOpen?

() => void

resetTimeout

number

Returns

CircuitBreaker

Methods

execute()

execute<T>(fn): TryResult<T, TryError<string>>;

Defined in: sync.ts:481

Type Parameters

T

T

Parameters

fn

() => T

Returns

TryResult<T, TryError<string>>

---

getState()

getState(): "closed" | "open" | "half-open";

Defined in: sync.ts:525

Returns

"closed" | "open" | "half-open"

---

reset()

reset(): void;

Defined in: sync.ts:519

Returns

void