Class WSConnection

constructor

• new WSConnection(url: string, logger?: Logger): WSConnection

  Parameters

  • url: string
  • Optionallogger: Logger

  Returns WSConnection

Readonlyurl

activeSubscriptions

• get activeSubscriptions(): string[]

  Returns string[]

addSubListener

• addSubListener<TPayload = unknown>(
      subId: string,
      callback: (payload: TPayload) => void,
  ): void

  Type Parameters

  • TPayload = unknown

  Parameters

  • subId: string
  • callback: (payload: TPayload) => void

  Returns void

cancelSubscription

• cancelSubscription<TPayload = unknown>(
      subId: string,
      callback: (payload: TPayload) => void,
      errorCallback?: (e: Error) => void,
  ): void

  Cancels a subscription, sending an unsubscribe request and handling responses.

  Type Parameters

  • TPayload = unknown

  Parameters

  • subId: string

    The subscription ID to cancel.

  • callback: (payload: TPayload) => void

    The original payload callback to remove.

  • OptionalerrorCallback: (e: Error) => void

    Optional callback for unsubscribe errors (defaults to logging).

  Returns void

close

• close(): void

  Returns void

closeSubscription

• closeSubscription(subId: string): void

  Parameters

  • subId: string

  Returns void

  Deprecated

  Use cancelSubscription for JSONRPC compliance.

connect

• connect(): Promise<void>

  Returns Promise<void>

createSubscription

• createSubscription<TPayload = unknown>(
      params: Omit<JsonRpcReqParams, "subId">,
      callback: (payload: TPayload) => void,
      errorCallback: (e: Error) => void,
  ): string

  Type Parameters

  • TPayload = unknown

  Parameters

  • params: Omit<JsonRpcReqParams, "subId">
  • callback: (payload: TPayload) => void
  • errorCallback: (e: Error) => void

  Returns string

ensureConnection

• ensureConnection(): Promise<void>

  Returns Promise<void>

onClose

• onClose(callback: (e: CloseEvent) => void): void

  Parameters

  • callback: (e: CloseEvent) => void

  Returns void

sendRequest

• sendRequest(method: "subscribe", params: JsonRpcReqParams): void

  Parameters

  • method: "subscribe"
  • params: JsonRpcReqParams

  Returns void

• sendRequest(method: "unsubscribe", params: { subId: string }): void

  Parameters

  • method: "unsubscribe"
  • params: { subId: string }

  Returns void