CircuitBreakerHandle
Defined in: src/circuit-breaker.ts:127
What a breaker extension can see and do.
Properties
Section titled “Properties”source
Section titled “source”
readonlysource:StrategySource
Defined in: src/circuit-breaker.ts:128
readonlystate:CircuitState
Defined in: src/circuit-breaker.ts:129
Methods
Section titled “Methods”adopt()
Section titled “adopt()”adopt(
snapshot):boolean
Defined in: src/circuit-breaker.ts:132
Take over a state decided elsewhere (another instance). Ignored unless it’s newer than ours; returns whether it was applied.
Parameters
Section titled “Parameters”snapshot
Section titled “snapshot”Returns
Section titled “Returns”boolean
onChange()
Section titled “onChange()”onChange(
listener):void
Defined in: src/circuit-breaker.ts:136
Called after every local state change (not after adopt).
Parameters
Section titled “Parameters”listener
Section titled “listener”(snapshot) => void
Returns
Section titled “Returns”void
snapshot()
Section titled “snapshot()”snapshot():
CircuitSnapshot
Defined in: src/circuit-breaker.ts:130
Returns
Section titled “Returns”trip()
Section titled “trip()”trip(
reason?):Promise<void>
Defined in: src/circuit-breaker.ts:134
Open the circuit for its break duration, e.g. after a failed health check.
Parameters
Section titled “Parameters”reason?
Section titled “reason?”unknown
Returns
Section titled “Returns”Promise<void>