Class Channel

constructor

• new Channel(
      topic: string,
      params?: object | (() => object),
      socket?: Socket,
  ): Channel

  Parameters

  • topic: string
  • Optionalparams: object | (() => object)
  • Optionalsocket: Socket

  Returns Channel

state

topic

join

• join(timeout?: number): Push

  Parameters

  • Optionaltimeout: number

  Returns Push

leave

• leave(timeout?: number): Push

  Parameters

  • Optionaltimeout: number

  Returns Push

off

• off(event: string, ref?: number): void

  Parameters

  • event: string
  • Optionalref: number

  Returns void

on

• on(event: string, callback: (response?: any) => void | Promise<void>): number

  Parameters

  • event: string
  • callback: (response?: any) => void | Promise<void>

  Returns number

onClose

• onClose(
      callback: (payload: any, ref: any, joinRef: any) => void | Promise<void>,
  ): number

  Parameters

  • callback: (payload: any, ref: any, joinRef: any) => void | Promise<void>

  Returns number

onError

• onError(callback: (reason?: any) => void | Promise<void>): number

  Parameters

  • callback: (reason?: any) => void | Promise<void>

  Returns number

onMessage

• onMessage(event: string, payload: any, ref: any): any

  Parameters

  • event: string
  • payload: any
  • ref: any

  Returns any

push

• push(event: string, payload: object, timeout?: number): Push

  Parameters

  • event: string
  • payload: object
  • Optionaltimeout: number

  Returns Push