RedisCircuitBreakerStore
Defined in: src/adapters/redis.ts:187
Circuit breaker state store backed by Redis JSON strings.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RedisCircuitBreakerStore(
client,prefix,setWithTTL):RedisCircuitBreakerStore
Defined in: src/adapters/redis.ts:188
Parameters
Section titled “Parameters”client
Section titled “client”prefix
Section titled “prefix”string
setWithTTL
Section titled “setWithTTL”(client, key, value, ttlSeconds) => Promise<unknown> | undefined
Returns
Section titled “Returns”RedisCircuitBreakerStore
Methods
Section titled “Methods”getState()
Section titled “getState()”getState(
key):Promise<CircuitBreakerSnapshot>
Defined in: src/adapters/redis.ts:222
Read the current snapshot for a circuit key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>
Implementation of
Section titled “Implementation of”recordFailure()
Section titled “recordFailure()”recordFailure(
key):Promise<CircuitBreakerSnapshot>
Defined in: src/adapters/redis.ts:233
Record a failed request and return the updated snapshot.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>
Implementation of
Section titled “Implementation of”CircuitBreakerStore.recordFailure
recordSuccess()
Section titled “recordSuccess()”recordSuccess(
key):Promise<CircuitBreakerSnapshot>
Defined in: src/adapters/redis.ts:226
Record a successful request and return the updated snapshot.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>
Implementation of
Section titled “Implementation of”CircuitBreakerStore.recordSuccess
reset()
Section titled “reset()”reset(
key):Promise<void>
Defined in: src/adapters/redis.ts:259
Fully reset a circuit, removing all state.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”transition()
Section titled “transition()”transition(
key,to):Promise<CircuitBreakerSnapshot>
Defined in: src/adapters/redis.ts:241
Transition the circuit to a new state and return the updated snapshot.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<CircuitBreakerSnapshot>