Class Socket

constructor

• new Socket(endPoint: string, opts?: Partial<SocketConnectOption>): Socket

  Parameters

  • endPoint: string
  • Optionalopts: Partial<SocketConnectOption>

  Returns Socket

ping

channel

• channel(topic: string, chanParams?: object): Channel

  Parameters

  • topic: string
  • OptionalchanParams: object

  Returns Channel

connect

• connect(params?: any): void

  Parameters

  • Optionalparams: any

  Returns void

connectionState

• connectionState(): ConnectionState

  Returns ConnectionState

disconnect

• disconnect(
      callback?: () => void | Promise<void>,
      code?: number,
      reason?: string,
  ): void

  Parameters

  • Optionalcallback: () => void | Promise<void>
  • Optionalcode: number
  • Optionalreason: string

  Returns void

endPointURL

• endPointURL(): string

  Returns string

hasLogger

• hasLogger(): boolean

  Returns boolean

isConnected

• isConnected(): boolean

  Returns boolean

log

• log(kind: string, message: string, data: any): void

  Parameters

  • kind: string
  • message: string
  • data: any

  Returns void

makeRef

• makeRef(): string

  Returns string

off

• off(refs: string[]): void

  Parameters

  • refs: string[]

  Returns void

onClose

• onClose(callback: (event: CloseEvent) => void | Promise<void>): string

  Parameters

  • callback: (event: CloseEvent) => void | Promise<void>

  Returns string

onError

• onError(
      callback: (
          error: string | number | Event,
          transport: new (endpoint: string) => object,
          establishedConnections: number,
      ) => void | Promise<void>,
  ): string

  Parameters

  • callback: (
        error: string | number | Event,
        transport: new (endpoint: string) => object,
        establishedConnections: number,
    ) => void | Promise<void>

  Returns string

onMessage

• onMessage(callback: (message: object) => void | Promise<void>): string

  Parameters

  • callback: (message: object) => void | Promise<void>

  Returns string

onOpen

• onOpen(callback: () => void | Promise<void>): string

  Parameters

  • callback: () => void | Promise<void>

  Returns string

protocol

• protocol(): string

  Returns string

push

• push(data: object): void

  Parameters

  • data: object

  Returns void

remove

• remove(channel: Channel): void

  Parameters

  • channel: Channel

  Returns void

replaceTransport

• replaceTransport(transport: new (endpoint: string) => object): void

  Parameters

  • transport: new (endpoint: string) => object

  Returns void