Class Node

constructor

• new Node(options: NodeOptions): Node

  Parameters

  • options: NodeOptions

  Returns Node

Readonlyname

Readonlyrest

clientId

• get clientId(): string

  Id of the bot

  Returns string

sessionId

• get sessionId(): string | null

  Id of the session

  Returns string | null

ping

• get ping(): number | null

  Round-trip time

  Returns number | null

stats

• get stats(): StatsPayload | null

  Stats from lavalink

  Returns StatsPayload | null

state

• get state(): NodeState

  Current state of the node

  Returns NodeState

connecting

• get connecting(): boolean

  The node is connecting

  Returns boolean

connected

• get connected(): boolean

  The node is connected

  Returns boolean

ready

• get ready(): boolean

  The node has connected and received the ready payload

  Returns boolean

reconnecting

• get reconnecting(): boolean

  The node is reconnecting

  Returns boolean

disconnected

• get disconnected(): boolean

  The node is disconnected (no connection, no reconnects)

  Returns boolean

reconnectAttempts

• get reconnectAttempts(): number

  Number of reconnects attempted

  Returns number

handshakeTimeout

• get handshakeTimeout(): number

  Initial handshake timeout in milliseconds

  Returns number

• set handshakeTimeout(ms: number): void

  Parameters

  • ms: number

  Returns void

connect

• connect(): Promise<boolean>

  Connects for a session with lavalink

  Returns Promise<boolean>

  true if the initial handshake succeeded, false otherwise

disconnect

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

  Closes connection to lavalink and stops reconnecting

  Parameters

  • reason: string = "disconnected"

    Reason for closing (only effective if a connection exists)

  Returns Promise<void>

toString

• toString(): string

  Returns a string representation of an object.

  Returns string