CircuitBreakerPolicy
Defined in: src/circuit-breaker.ts:146
Decides when a closed circuit opens (cockatiel’s IBreaker). Only calls made while closed are recorded; now is the
pipeline’s time provider. One instance per breaker: it holds that breaker’s history.
Methods
Section titled “Methods”metrics()?
Section titled “metrics()?”
optionalmetrics(now):CircuitMetrics
Defined in: src/circuit-breaker.ts:153
For stateProvider.metrics and breakDurationGenerator; zeros when absent.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”record()
Section titled “record()”record(
failed,now):void
Defined in: src/circuit-breaker.ts:147
Parameters
Section titled “Parameters”failed
Section titled “failed”boolean
number
Returns
Section titled “Returns”void
reset()
Section titled “reset()”reset():
void
Defined in: src/circuit-breaker.ts:151
Called when the circuit closes.
Returns
Section titled “Returns”void
restore()?
Section titled “restore()?”
optionalrestore(state):void
Defined in: src/circuit-breaker.ts:157
Receives initialState.window, which may come from another policy or be malformed: validate it.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”void
shouldOpen()
Section titled “shouldOpen()”shouldOpen(
now):boolean
Defined in: src/circuit-breaker.ts:149
Asked after each recorded failure (outside warm-up).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”boolean
snapshot()?
Section titled “snapshot()?”
optionalsnapshot():unknown
Defined in: src/circuit-breaker.ts:155
JSON-serializable history, stored as CircuitSnapshot.window.
Returns
Section titled “Returns”unknown