Class Node

constructor

• new Node(options: NodeOptions): Node

  Parameters

  • options: NodeOptions

  Returns Node

Readonlyname

Readonlyrest

clientId

• get clientId(): string

  Returns string

sessionId

• get sessionId(): string | null

  Returns string | null

ping

• get ping(): number | null

  Returns number | null

stats

• get stats(): StatsPayload | null

  Returns StatsPayload | null

state

• get state(): NodeState

  Returns NodeState

connecting

• get connecting(): boolean

  Returns boolean

connected

• get connected(): boolean

  Returns boolean

ready

• get ready(): boolean

  Returns boolean

reconnecting

• get reconnecting(): boolean

  Returns boolean

disconnected

• get disconnected(): boolean

  Returns boolean

reconnectLimit

• get reconnectLimit(): number

  Returns number

reconnectAttempts

• get reconnectAttempts(): number

  Returns number

connect

• connect(): Promise<boolean>

  Returns Promise<boolean>

disconnect

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

  Parameters

  • code: number = CloseCodes.Normal
  • reason: string = "disconnected"

  Returns Promise<void>

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

connect

• connect(reconnects: number, name: string): void

  Parameters

  • reconnects: number
  • name: string

  Returns void

ready

• ready(resumed: boolean, sessionId: string, name: string): void

  Parameters

  • resumed: boolean
  • sessionId: string
  • name: string

  Returns void

dispatch

• dispatch(payload: MessagePayload, name: string): void

  Parameters

  • payload: MessagePayload
  • name: string

  Returns void

error

• error(error: Error, name: string): void

  Parameters

  • error: Error
  • name: string

  Returns void

close

• close(code: number, reason: string, name: string): void

  Parameters

  • code: number
  • reason: string
  • name: string

  Returns void

disconnect

• disconnect(code: number, reason: string, byLocal: boolean, name: string): void

  Parameters

  • code: number
  • reason: string
  • byLocal: boolean
  • name: string

  Returns void