Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Hierarchy

  • BaseClient
    • Client

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Client(options: BaseClientOptions): Client

  • Parameters

    • options: BaseClientOptions

    Returns Client

Properties

id

id: string

options

options: BaseClientOptions

Accessors

rooms

Methods

connect

  • Connect the underlay WebSocket connection to the SignalWire network.

    Returns Promise<Client>

    Promise that will resolve with the Client object.

destroy

  • destroy(): void

  • Returns void

disconnect

  • disconnect(): void

  • Disconnect the Client from the SignalWire network.

    Returns void

    void

off

  • off(...params: [event: string | symbol, fn?: (...args: any[]) => void, context?: any, once?: boolean]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event: string | symbol, fn?: (...args: any[]) => void, context?: any, once?: boolean]

    Returns EventEmitter<string | symbol, any>

on

  • on(...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]

    Returns EventEmitter<string | symbol, any>

once

  • once(...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]

    Returns EventEmitter<string | symbol, any>

removeAllListeners

  • removeAllListeners(...params: [event?: string | symbol]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event?: string | symbol]

    Returns EventEmitter<string | symbol, any>