Class CircuitBreakerInterceptor

Circuit breaker for failing endpoints.

Implements

Interceptor

Index

Accessors

Constructors

Methods

onRequest onResponse onError beforeCall recordSuccess recordFailure

Accessors

currentState

get currentState(): State
Current circuit state.

Returns State

Constructors

constructor

new CircuitBreakerInterceptor(
opts?: CircuitBreakerOptions,
): CircuitBreakerInterceptor
Parameters
- opts: CircuitBreakerOptions = {}
Returns CircuitBreakerInterceptor

Methods

onRequest

onRequest(_ctx: CallContext, request: unknown): Promise<unknown>
Parameters
- _ctx: CallContext
- request: unknown
Returns Promise<unknown>
Implementation of Interceptor.onRequest

onResponse

onResponse(_ctx: CallContext, response: unknown): Promise<unknown>
Parameters
- _ctx: CallContext
- response: unknown
Returns Promise<unknown>
Implementation of Interceptor.onResponse

onError

onError(_ctx: CallContext, error: RpcError): Promise<RpcError>
Parameters
- _ctx: CallContext
- error: RpcError
Returns Promise<RpcError>
Implementation of Interceptor.onError

beforeCall

beforeCall(): void
Pre-call gate check — throws if circuit is open. Alias for the logic in onRequest(), callable without a full call context.

Returns void

recordSuccess

recordSuccess(): void
Record a successful call — resets the failure count.

Returns void

recordFailure

recordFailure(): void
Record a failed call — may open the circuit.

Returns void