Class CircuitBreaker

Index

Constructors

Accessors

currentState enabled

Methods

check currentStateFor recordFailure recordSuccess reset

Constructors

constructor

new CircuitBreaker(
config: false | HomeportCircuitBreakerConfig | undefined,
logger: HomeportLogger,
): CircuitBreaker
Parameters
- config: false | HomeportCircuitBreakerConfig | undefined
- logger: HomeportLogger
Returns CircuitBreaker
- Defined in src/core/circuit-breaker.ts:40

Accessors

currentState

get currentState(): CircuitBreakerState
Backward-compatible getter — returns the state of the first tracked endpoint, or a default closed state if no endpoints have been recorded yet.

Returns CircuitBreakerState

Deprecated
Prefer currentStateFor(url) for per-endpoint diagnostics.
- Defined in src/core/circuit-breaker.ts:141

enabled

get enabled(): boolean
Whether the circuit breaker is enabled.

Returns boolean
- Defined in src/core/circuit-breaker.ts:132

Methods

check

check(url?: string): void
Check if a request to url is allowed through. Throws if circuit is open.
Parameters
- Optionalurl: string
Returns void
- Defined in src/core/circuit-breaker.ts:87

currentStateFor

currentStateFor(url: string): CircuitBreakerState
Current circuit breaker state for the endpoint group that url belongs to (read-only, does not create entries).
Parameters
- url: string
Returns CircuitBreakerState
- Defined in src/core/circuit-breaker.ts:148

recordFailure

recordFailure(url?: string): void
Record a failed request — may trip the circuit open.
Parameters
- Optionalurl: string
Returns void
- Defined in src/core/circuit-breaker.ts:117

recordSuccess

recordSuccess(url?: string): void
Record a successful request — resets the failure counter.
Parameters
- Optionalurl: string
Returns void
- Defined in src/core/circuit-breaker.ts:108

reset

reset(): void
Reset all circuit states.

Returns void
- Defined in src/core/circuit-breaker.ts:156