Type Alias ICircuitBreakerAdapter

Type declaration

• getState:function

  • getState(key: string): Promise<CircuitBreakerState>

  • The getState method returns the state of the circuit breaker. The circuit breaker can be closed, open, half open state and isolated state.

    Parameters

    • key: string

    Returns Promise<CircuitBreakerState>

• isolate:function

  • isolate(key: string): Promise<void>

  • The isolate method will transition the circuit breaker to isolated state, meaning the circuit breaker will reject all attempts untill it is manually reset.

    Parameters

    • key: string

    Returns Promise<void>

• reset:function

  • reset(key: string): Promise<void>

  • The reset method resets circuit breaker to its initial state regardless of the current state.

    Parameters

    • key: string

    Returns Promise<void>

• trackFailure:function

  • trackFailure(key: string): Promise<void>

  • The trackFailure will method will track failure metric that will be used in updateState method.

    Parameters

    • key: string

    Returns Promise<void>

• trackSuccess:function

  • trackSuccess(key: string): Promise<void>

  • The trackSuccess will method will track success metric that will be used in updateState method.

    Parameters

    • key: string

    Returns Promise<void>

• updateState:function

  • updateState(key: string): Promise<CircuitBreakerStateTransition>

  • The updateState method updates the state of the circuit breaker and returns the state transition.

    Parameters

    • key: string

    Returns Promise<CircuitBreakerStateTransition>