Class LavalinkNode

constructor

• new LavalinkNode(options): LavalinkNode

• Parameters

  • options: NodeOptions

  Returns LavalinkNode

Readonly name

Readonly rest

clientId

• get clientId(): string

• Returns string

sessionId

• get sessionId(): null | string

• Returns null | string

ping

• get ping(): null | number

• Returns null | number

stats

• get stats(): null | StatsPayload

• Returns null | StatsPayload

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>

• Connect to the Lavalink node Handles reconnection attempts and session resumption

  Returns Promise<boolean>

disconnect

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

• Disconnect from the Lavalink node

  Parameters

  • code: number = CloseCodes.Normal

    WebSocket close code
  • reason: string = "disconnected"

    Disconnect reason

  Returns Promise<void>

setSponsorBlock

• setSponsorBlock(player, segments): Promise<void>

• Set SponsorBlock segments for a player

  Parameters

  • player: {
        guildId: string;
    }

    • guildId: string

  • segments: string[]

  Returns Promise<void>

getSponsorBlock

• getSponsorBlock(player): Promise<string[]>

• Get current SponsorBlock segments for a player

  Parameters

  • player: {
        guildId: string;
    }

    • guildId: string

  Returns Promise<string[]>

deleteSponsorBlock

• deleteSponsorBlock(player): Promise<void>

• Delete SponsorBlock configuration for a player

  Parameters

  • player: {
        guildId: string;
    }

    • guildId: string

  Returns Promise<void>

toString

• toString(): string

• Returns string