CircuitBreakerStrategy
Defined in: src/circuit-breaker.ts:258
Type Parameters
Section titled “Type Parameters”T
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CircuitBreakerStrategy<
T>(options,source):CircuitBreakerStrategy<T>
Defined in: src/circuit-breaker.ts:282
Parameters
Section titled “Parameters”options
Section titled “options”source
Section titled “source”Returns
Section titled “Returns”CircuitBreakerStrategy<T>
Accessors
Section titled “Accessors”lastFailure
Section titled “lastFailure”Get Signature
Section titled “Get Signature”get lastFailure():
Outcome<T> |undefined
Defined in: src/circuit-breaker.ts:373
The last outcome counted as a failure, if any.
Returns
Section titled “Returns”Outcome<T> | undefined
metrics
Section titled “metrics”Get Signature
Section titled “Get Signature”get metrics():
CircuitMetrics
Defined in: src/circuit-breaker.ts:368
Window counts (closed state).
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get state():
CircuitState
Defined in: src/circuit-breaker.ts:363
Current state.
Returns
Section titled “Returns”warmingUp
Section titled “warmingUp”Get Signature
Section titled “Get Signature”get warmingUp():
boolean
Defined in: src/circuit-breaker.ts:358
True during warmUpDuration, while failures are recorded but can’t open the circuit.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: src/circuit-breaker.ts:393
Stops extensions (health checks, state sync).
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”execute()
Section titled “execute()”execute(
next,context):Promise<{error:unknown;ok:false; } | {ok:true;result:T; }>
Defined in: src/circuit-breaker.ts:422
Parameters
Section titled “Parameters”Next<T>
context
Section titled “context”Returns
Section titled “Returns”Promise<{ error: unknown; ok: false; } | { ok: true; result: T; }>
Implementation of
Section titled “Implementation of”reset()
Section titled “reset()”reset():
Promise<void>
Defined in: src/circuit-breaker.ts:388
Close the circuit now and clear its window.
Returns
Section titled “Returns”Promise<void>
snapshot()
Section titled “snapshot()”snapshot():
CircuitSnapshot
Defined in: src/circuit-breaker.ts:378
Plain-JSON state for persistence; pass it back as initialState.
Returns
Section titled “Returns”trip()
Section titled “trip()”trip():
Promise<void>
Defined in: src/circuit-breaker.ts:383
Open the circuit now for its normal break duration (unlike isolate, it half-opens by itself afterwards).
Returns
Section titled “Returns”Promise<void>