Class LoadBalancer

Hierarchy

  • EventEmitter
    • LoadBalancer

Constructors

constructor

Properties

prefixed

Methods

addListener addUpstream destroy emit eventNames getMetrics listenerCount listeners off on once recordRequest removeAllListeners removeListener removeUpstream selectUpstream

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

addUpstream

destroy

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)[]

getMetrics

  • getMetrics(): {
        distribution: {
            endpoint: string;
            percentage: number;
        }[];
        healthyUpstreams: number;
        strategy:
            | "round-robin"
            | "weighted"
            | "least-latency"
            | "health-based"
            | "adaptive";
        totalRequests: number;
        totalUpstreams: number;
        upstreams: {
            endpoint: string;
            errorRate: number;
            healthy: boolean;
            latency: number;
            requests: number;
            throughput: number;
            weight: number;
        }[];
    }

  • 📊 Get load balancer metrics

    Returns {
        distribution: {
            endpoint: string;
            percentage: number;
        }[];
        healthyUpstreams: number;
        strategy:
            | "round-robin"
            | "weighted"
            | "least-latency"
            | "health-based"
            | "adaptive";
        totalRequests: number;
        totalUpstreams: number;
        upstreams: {
            endpoint: string;
            errorRate: number;
            healthy: boolean;
            latency: number;
            requests: number;
            throughput: number;
            weight: number;
        }[];
    }

    • distribution: {
          endpoint: string;
          percentage: number;
      }[]
    • healthyUpstreams: number
    • strategy:
          | "round-robin"
          | "weighted"
          | "least-latency"
          | "health-based"
          | "adaptive"
    • totalRequests: number
    • totalUpstreams: number
    • upstreams: {
          endpoint: string;
          errorRate: number;
          healthy: boolean;
          latency: number;
          requests: number;
          throughput: number;
          weight: 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

recordRequest

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

removeUpstream

selectUpstream

Settings

Member Visibility

On This Page

Constructors
Properties
Methods