Class CircuitBreakerRegistry

Registry that manages one CircuitBreaker per key (typically per origin/host). Automatically creates breakers on first use.

Index

Constructors

Accessors

Methods

get execute trip reset snapshots delete clear

Constructors

constructor

new CircuitBreakerRegistry(
defaultConfig?: CircuitBreakerConfig,
): CircuitBreakerRegistry
Parameters
- defaultConfig: CircuitBreakerConfig = {}
  Default configuration inherited by all breakers
Returns CircuitBreakerRegistry
- Defined in src/circuit-breaker.ts:475

Accessors

size

get size(): number
How many breakers are registered.

Returns number
- Defined in src/circuit-breaker.ts:526

Methods

get

get(key: string, overrides?: CircuitBreakerConfig): CircuitBreaker
Get or create a circuit breaker for key. key is typically the request origin, e.g. "https://api.example.com".
Parameters
- key: string
- Optionaloverrides: CircuitBreakerConfig
Returns CircuitBreaker
- Defined in src/circuit-breaker.ts:483

execute

execute<T>(
    key: string,
    fn: () => Promise<T>,
    overrides?: CircuitBreakerConfig,
): Promise<T>
Wrap a function call through the breaker for key. Creates the breaker if it doesn't exist.
Type Parameters
- T
Parameters
- key: string
- fn: () => Promise<T>
- Optionaloverrides: CircuitBreakerConfig
Returns Promise<T>
- Defined in src/circuit-breaker.ts:494

trip

trip(key: string): void
Manually trip the breaker for key (creates it if it doesn't exist).
Parameters
- key: string
Returns void
- Defined in src/circuit-breaker.ts:499

reset

reset(key: string): void
Manually reset the breaker for key (creates it if it doesn't exist).
Parameters
- key: string
Returns void
- Defined in src/circuit-breaker.ts:504

snapshots

snapshots(): Record<string, CircuitBreakerState>
Snapshot all breakers — for monitoring / health endpoints.

Returns Record<string, CircuitBreakerState>
- Defined in src/circuit-breaker.ts:509

delete

delete(key: string): void
Remove a specific breaker.
Parameters
- key: string
Returns void
- Defined in src/circuit-breaker.ts:516

clear

clear(): void
Remove all breakers.

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