CircuitBreakerStore
Defined in: src/policies/resilience/circuit-breaker.ts:47
Pluggable storage backend for circuit breaker state.
Implement this interface to store circuit state in Durable Objects, KV, or any shared datastore for multi-instance deployments.
Methods
Section titled “Methods”destroy()?
Section titled “destroy()?”
optionaldestroy():void
Defined in: src/policies/resilience/circuit-breaker.ts:59
Optional cleanup - release timers, close connections, etc.
Returns
Section titled “Returns”void
getState()
Section titled “getState()”getState(
key):Promise<CircuitBreakerSnapshot>
Defined in: src/policies/resilience/circuit-breaker.ts:49
Read the current snapshot for a circuit key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>
recordFailure()
Section titled “recordFailure()”recordFailure(
key):Promise<CircuitBreakerSnapshot>
Defined in: src/policies/resilience/circuit-breaker.ts:53
Record a failed request and return the updated snapshot.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>
recordSuccess()
Section titled “recordSuccess()”recordSuccess(
key):Promise<CircuitBreakerSnapshot>
Defined in: src/policies/resilience/circuit-breaker.ts:51
Record a successful request and return the updated snapshot.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>
reset()
Section titled “reset()”reset(
key):Promise<void>
Defined in: src/policies/resilience/circuit-breaker.ts:57
Fully reset a circuit, removing all state.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
transition()
Section titled “transition()”transition(
key,to):Promise<CircuitBreakerSnapshot>
Defined in: src/policies/resilience/circuit-breaker.ts:55
Transition the circuit to a new state and return the updated snapshot.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>