Type Alias ICircuitBreakerPolicy<TMetrics>

Type declaration

• initialMetrics:function

  • initialMetrics(): TMetrics

  • Returns TMetrics

• isEqual?:function

  • isEqual(metricsA: TMetrics, metricsB: TMetrics): boolean

  • The isEqual method should return true only when both metrics are equal. This method is optional, it is only used for optimization purposes.

    Parameters

    • metricsA: TMetrics
    • metricsB: TMetrics

    Returns boolean

• trackFailure:function

  • trackFailure(
        currentState: CircuitBreakerTrackState<TMetrics>,
        settings: CircuitBreakerTrackSettings<TMetrics>,
    ): TMetrics

  • The trackFailure method updates the metrics when failure occurs. The metrics will be used whenClosed and whenHalfOpen methods.

    Parameters

    • currentState: CircuitBreakerTrackState<TMetrics>
    • settings: CircuitBreakerTrackSettings<TMetrics>

    Returns TMetrics

• trackSuccess:function

  • trackSuccess(
        currentState: CircuitBreakerTrackState<TMetrics>,
        settings: CircuitBreakerTrackSettings<TMetrics>,
    ): TMetrics

  • The trackSuccess method updates the metrics when success occurs.

    Parameters

    • currentState: CircuitBreakerTrackState<TMetrics>
    • settings: CircuitBreakerTrackSettings<TMetrics>

    Returns TMetrics

• whenClosed:function

  • whenClosed(currentMetrics: TMetrics, currentDate: Date): ClosedTransitions

  • The whenClosed method should use currentMetrics and if needed currentDate to transition to open state or stay in closed state.

    Parameters

    • currentMetrics: TMetrics
    • currentDate: Date

    Returns ClosedTransitions

• whenHalfOpened:function

  • whenHalfOpened(currentMetrics: TMetrics, currentDate: Date): HalfOpenTransitions

  • The whenHalfOpened method should use currentMetrics and if needed currentDate to transition to open state, closed state or stay in half open state.

    Parameters

    • currentMetrics: TMetrics
    • currentDate: Date

    Returns HalfOpenTransitions