Type Alias ICircuitBreaker

Type declaration

• isolate:function

  • isolate(): ITask<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.

    Returns ITask<void>

• reset:function

  • reset(): ITask<void>

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

    Returns ITask<void>

• runOrFail:function

  • runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): ITask<TValue>

  • The runOrFail method runs asyncFn in when the circuit breaker is in closed state and half opend state. Throws an error when in opend state.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns ITask<TValue>

    Throws

    OpenCircuitBreakerError