Class CircuitBreaker

Implements

ICircuitBreaker

Index

Constructors

Methods

setClient checkCircuit recordSuccess recordFailure getState getStats reset cleanup getKeyStrategy destroy shutdown

Constructors

constructor

new CircuitBreaker(config?: CircuitBreakerConfig, clock?: Clock): CircuitBreaker
Parameters
- config: CircuitBreakerConfig = {}
- Optionalclock: Clock
  where the breaker reads time for its reset timeout and stale-circuit checks. Defaults to the wall clock.
Returns CircuitBreaker
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:49

Methods

setClient

setClient(client: ApiClient | null): void
Parameters
- client: ApiClient | null
Returns void
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:41

checkCircuit

checkCircuit(endpoint: string): void
Parameters
- endpoint: string
Returns void
Implementation of ICircuitBreaker.checkCircuit
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:83

recordSuccess

recordSuccess(endpoint: string): void
Parameters
- endpoint: string
Returns void
Implementation of ICircuitBreaker.recordSuccess
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:114

recordFailure

recordFailure(endpoint: string, statusCode: number): void
Parameters
- endpoint: string
- statusCode: number
Returns void
Implementation of ICircuitBreaker.recordFailure
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:134

getState

getState(endpoint: string): CircuitState
Parameters
- endpoint: string
Returns CircuitState
Implementation of ICircuitBreaker.getState
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:171

getStats

getStats(): {
    totalCircuits: number;
    openCircuits: number;
    circuits: Record<string, { state: CircuitState; failures: number }>;
}
Returns {
    totalCircuits: number;
    openCircuits: number;
    circuits: Record<string, { state: CircuitState; failures: number }>;
}
Implementation of ICircuitBreaker.getStats
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:186

reset

reset(endpoint?: string): void
Parameters
- Optionalendpoint: string
Returns void
Implementation of ICircuitBreaker.reset
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:209

cleanup

cleanup(): number
Returns number
Implementation of ICircuitBreaker.cleanup
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:217

getKeyStrategy

getKeyStrategy(): "resolved" | "template"
Returns the configured key strategy. Optional for backward compatibility.

Returns "resolved" | "template"
Implementation of ICircuitBreaker.getKeyStrategy
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:243

destroy

destroy(): void
Release resources (timers). Optional for backward compatibility.

Returns void
Implementation of ICircuitBreaker.destroy
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:247

shutdown

shutdown(): void
Returns void
Implementation of ICircuitBreaker.shutdown
- Defined in src/core/circuitBreaker/CircuitBreaker.ts:255