CircuitBreakerManualControl
Defined in: src/circuit-breaker.ts:166
Manually isolate (hold open) or close one or more circuit breakers, e.g. from an admin endpoint or a health check.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CircuitBreakerManualControl(
isIsolated?):CircuitBreakerManualControl
Defined in: src/circuit-breaker.ts:170
Parameters
Section titled “Parameters”isIsolated?
Section titled “isIsolated?”boolean = false
Returns
Section titled “Returns”CircuitBreakerManualControl
Accessors
Section titled “Accessors”isIsolated
Section titled “isIsolated”Get Signature
Section titled “Get Signature”get isIsolated():
boolean
Defined in: src/circuit-breaker.ts:174
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: src/circuit-breaker.ts:192
Closes the circuits now, dropping every outstanding isolation.
Returns
Section titled “Returns”Promise<void>
isolate()
Section titled “isolate()”isolate():
Promise<() =>Promise<void>>
Defined in: src/circuit-breaker.ts:182
Holds the circuits isolated until every isolation is released (stacking) or close() is called.
Resolves to the release function of this isolation; releasing twice, or after close(), does nothing.
Returns
Section titled “Returns”Promise<() => Promise<void>>