Class CircuitBreaker

Hierarchy

  • EventEmitter
    • CircuitBreaker

Constructors

constructor

Properties

prefixed

Methods

addListener emit eventNames execute forceClose forceHalfOpen forceOpen getAdvancedMetrics getHealthStatus getMetrics listenerCount listeners off on once removeAllListeners removeListener reset updateConfig

Constructors

constructor

Properties

Staticprefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Rest...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

execute

forceClose

forceHalfOpen

forceOpen

getAdvancedMetrics

  • getAdvancedMetrics(): {
        availability: {
            1h: number;
            24h: number;
            current: number;
        };
        config: CircuitBreakerConfig;
        failureRate: number;
        failures: number;
        lastFailureTime: number;
        mttr: number;
        nextAttemptIn: number;
        performance: {
            averageResponseTime: number;
            errorBudget: number;
            requestsPerSecond: number;
        };
        recentRequests: number;
        state: "open" | "half-open" | "closed";
        successCount: number;
        totalRequests: number;
    }

  • 📊 Advanced analytics

    Returns {
        availability: {
            1h: number;
            24h: number;
            current: number;
        };
        config: CircuitBreakerConfig;
        failureRate: number;
        failures: number;
        lastFailureTime: number;
        mttr: number;
        nextAttemptIn: number;
        performance: {
            averageResponseTime: number;
            errorBudget: number;
            requestsPerSecond: number;
        };
        recentRequests: number;
        state: "open" | "half-open" | "closed";
        successCount: number;
        totalRequests: number;
    }

    • availability: {
          1h: number;
          24h: number;
          current: number;
      }
      • 1h: number
      • 24h: number
      • current: number
    • config: CircuitBreakerConfig
    • failureRate: number
    • failures: number
    • lastFailureTime: number
    • mttr: number
    • nextAttemptIn: number
    • performance: {
          averageResponseTime: number;
          errorBudget: number;
          requestsPerSecond: number;
      }
      • averageResponseTime: number
      • errorBudget: number
      • requestsPerSecond: number
    • recentRequests: number
    • state: "open" | "half-open" | "closed"
    • successCount: number
    • totalRequests: number

getHealthStatus

  • getHealthStatus(): {
        availability: number;
        failureRate: number;
        health: "healthy" | "degraded" | "unhealthy";
        state: "open" | "half-open" | "closed";
        uptime: number;
    }

  • 📊 Get health status

    Returns {
        availability: number;
        failureRate: number;
        health: "healthy" | "degraded" | "unhealthy";
        state: "open" | "half-open" | "closed";
        uptime: number;
    }

    • availability: number
    • failureRate: number
    • health: "healthy" | "degraded" | "unhealthy"
    • state: "open" | "half-open" | "closed"
    • uptime: number

getMetrics

  • getMetrics(): {
        config: CircuitBreakerConfig;
        failureRate: number;
        failures: number;
        lastFailureTime: number;
        nextAttemptIn: number;
        recentRequests: number;
        state: "open" | "half-open" | "closed";
        successCount: number;
        totalRequests: number;
    }

  • 📈 Get circuit breaker metrics

    Returns {
        config: CircuitBreakerConfig;
        failureRate: number;
        failures: number;
        lastFailureTime: number;
        nextAttemptIn: number;
        recentRequests: number;
        state: "open" | "half-open" | "closed";
        successCount: number;
        totalRequests: number;
    }

    • config: CircuitBreakerConfig
    • failureRate: number
    • failures: number
    • lastFailureTime: number
    • nextAttemptIn: number
    • recentRequests: number
    • state: "open" | "half-open" | "closed"
    • successCount: number
    • totalRequests: number

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners<T>(event): ((...args: any[]) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

    Returns ((...args: any[]) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • fn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: string | symbol

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T
    • Optionalfn: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

reset

updateConfig

Settings

Member Visibility

On This Page

Constructors
Properties
Methods