Hierarchy

  • EventEmitter
    • WebSocketClient

Constructors

Properties

prefixed: string | boolean

Methods

  • 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

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

    Type Parameters

    • T extends string | symbol

    Parameters

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

    Returns boolean

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

    Returns (string | symbol)[]

  • Get real-time metrics

    Returns {
        cache: null | CacheStats & {
            compressionStats: {
                ratio: number;
                savedBytes: number;
            };
            hotKeys: {
                hits: number;
                key: string;
            }[];
            memoryDistribution: {
                distributed: number;
                l1: number;
                l2: number;
            };
            predictiveAccuracy: number;
        };
        circuitBreaker: null | {
            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;
        };
        connection: {
            reconnectAttempts: number;
            reconnectCount: number;
            state:
                | "disconnected"
                | "connecting"
                | "connected"
                | "reconnecting";
        };
        performance: {
            latency: {
                average: number;
                last: number;
            };
            throughput: {
                messagesReceived: number;
                messagesSent: number;
            };
        };
        subscriptions: {
            active: number;
            total: number;
        };
    }

    • cache: null | CacheStats & {
          compressionStats: {
              ratio: number;
              savedBytes: number;
          };
          hotKeys: {
              hits: number;
              key: string;
          }[];
          memoryDistribution: {
              distributed: number;
              l1: number;
              l2: number;
          };
          predictiveAccuracy: number;
      }
    • circuitBreaker: null | {
          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;
      }
    • connection: {
          reconnectAttempts: number;
          reconnectCount: number;
          state:
              | "disconnected"
              | "connecting"
              | "connected"
              | "reconnecting";
      }
      • reconnectAttempts: number
      • reconnectCount: number
      • state:
            | "disconnected"
            | "connecting"
            | "connected"
            | "reconnecting"
    • performance: {
          latency: {
              average: number;
              last: number;
          };
          throughput: {
              messagesReceived: number;
              messagesSent: number;
          };
      }
      • latency: {
            average: number;
            last: number;
        }
        • average: number
        • last: number
      • throughput: {
            messagesReceived: number;
            messagesSent: number;
        }
        • messagesReceived: number
        • messagesSent: number
    • subscriptions: {
          active: number;
          total: number;
      }
      • active: number
      • total: number
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends string | symbol

    Parameters

    • event: T

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

  • 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

  • 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

  • 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

  • Program subscription with filtering

    Parameters

    • programId: string
    • callback: ((accountInfo: any) => void)
        • (accountInfo): void
        • Parameters

          • accountInfo: any

          Returns void

    • options: SubscriptionOptions & {
          encoding?: "base58" | "base64" | "jsonParsed";
          filters?: any[];
      } = {}

    Returns Promise<number>

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

    Parameters

    • Optionalevent: string | symbol

    Returns 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