Class CircuitBreaker

Index

Constructors

Methods

execute recordFailure recordSuccess forceState reset getState getStats

Constructors

constructor

new CircuitBreaker(config): CircuitBreaker
Parameters
- config: Partial<CircuitBreakerConfig> & {
  name: string;
  }
Returns CircuitBreaker
- Defined in src/safety/runtime/CircuitBreaker.ts:62

Methods

execute

execute<T>(fn): Promise<T>
Type Parameters
- T
Parameters
- fn: (() => Promise<T>)
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
- Defined in src/safety/runtime/CircuitBreaker.ts:66

recordFailure

recordFailure(): void
Returns void
- Defined in src/safety/runtime/CircuitBreaker.ts:88

recordSuccess

recordSuccess(): void
Returns void
- Defined in src/safety/runtime/CircuitBreaker.ts:105

forceState

forceState(state): void
Parameters
- state: CircuitState
Returns void
- Defined in src/safety/runtime/CircuitBreaker.ts:116

reset

reset(): void
Returns void
- Defined in src/safety/runtime/CircuitBreaker.ts:120

getState

getState(): CircuitState
Returns CircuitState
- Defined in src/safety/runtime/CircuitBreaker.ts:128

getStats

getStats(): CircuitBreakerStats
Returns CircuitBreakerStats
- Defined in src/safety/runtime/CircuitBreaker.ts:139