Node

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class Node {}

Properties

Property	Type	Description
info	LavalinkInfo | null	Lavalink node information. null until connected.
isNodeLink	boolean	Whether the node is a NodeLink node.
manager	Manager	The manager instance this node belongs to.
options	NodeOptions	The resolved options for this node.
rest	Rest	The REST instance for this node.
sessionId	string | null	The current session ID. null until connected.
socket	WebSocket | null	The active WebSocket connection, or null.
stats	NodeStats	The current node statistics.

Constructor

new Node(manager: Manager, options: NodeOptions)

Parameter	Type	Description	Optional
manager	Manager	The manager instance.
options	NodeOptions	The node options.

Methods

address

get address(): string

Returns the full address of this node in host:port format.

Returns

Type	Description
string	The node address.

---

connect()

async connect(): Promise<void>

Connects to the Lavalink node via WebSocket. Loads the stored session ID before connecting and includes it in the handshake headers if available.

---

connected

get connected(): boolean

Returns whether the node currently has an open WebSocket connection.

Returns

Type	Description
boolean	true if the WebSocket is open.

---

deleteSponsorBlock()

warning

This method requires the SponsorBlock plugin to be installed on the Lavalink node.

async deleteSponsorBlock(player: Player): Promise<void>

Removes all SponsorBlock segment categories for a player.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.

---

destroy()

async destroy(): Promise<void>

Destroys the node, moves all connected players to another node, closes the WebSocket connection, and removes the node from the manager.

---

error()

warning

This method is protected and should not be called directly.

protected error(error: Error): void

Handles a WebSocket error event, emitting a nodeError event on the manager.

Parameters

Parameter	Type	Description	Optional
error	Error	The error.

---

fetchInfo()

async fetchInfo(): Promise<LavalinkInfo>

Fetches current information from the Lavalink node via the REST API.

Returns

Type	Description
Promise<LavalinkInfo>	The node info.

---

getLyrics()

warning

This method requires the LavaLyrics plugin, plus either lavasrc-plugin or java-lyrics-plugin.
For NodeLink nodes, no additional plugins are required.

async getLyrics(track: Track, skipTrackSource?: boolean, language?: string): Promise<Lyrics | NodeLinkGetLyrics>

Fetches lyrics for a track. Uses a NodeLink-specific endpoint when isNodeLink is true.

Parameters

Parameter	Type	Description	Optional
track	Track	The track to fetch lyrics for.
skipTrackSource	boolean	Whether to skip the track's source URL. Defaults to false.
language	string	The preferred language for lyrics (NodeLink only).

Returns

Type	Description
Promise<Lyrics | NodeLinkGetLyrics>	The lyrics data.

---

getSponsorBlock()

warning

This method requires the SponsorBlock plugin to be installed on the Lavalink node.

async getSponsorBlock(player: Player): Promise<SponsorBlockSegment[]>

Returns the active SponsorBlock segment categories for a player.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.

Returns

Type	Description
Promise<SponsorBlockSegment[]>	The active segment categories.

---

handleEvent()

warning

This method is protected and should not be called directly.

async handleEvent(payload: PlayerEvent & PlayerEvents): Promise<void>

Routes an incoming Lavalink event payload to the appropriate handler method.

Parameters

Parameter	Type	Description	Optional
payload	PlayerEvent & PlayerEvents	The event payload.

---

loadSessionIds()

async loadSessionIds(): Promise<void>

Loads the persisted session ID for this node from the configured storage backend (JSON file or Redis hash). Sets sessionId to null if no stored value is found.

---

lyricsSubscribe()

warning

This method requires the LavaLyrics plugin, plus either lavasrc-plugin or java-lyrics-plugin.
Not supported on NodeLink nodes.

async lyricsSubscribe(guildId: string, skipTrackSource?: boolean): Promise<unknown>

Subscribes a player to real-time lyrics events.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID.
skipTrackSource	boolean	Whether to skip the track's source URL. Defaults to false.

Returns

Type	Description
Promise<unknown>	The response from the Lavalink session lyrics endpoint.

---

lyricsUnsubscribe()

warning

This method requires the java-lyrics-plugin to be installed on the Lavalink node.
Not supported on NodeLink nodes.

async lyricsUnsubscribe(guildId: string): Promise<unknown>

Unsubscribes a player from real-time lyrics events.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID.

Returns

Type	Description
Promise<unknown>	The response from the Lavalink session lyrics endpoint.

---

message()

warning

This method is protected and should not be called directly.

async message(d: Buffer | string): Promise<void>

Handles an incoming WebSocket message from Lavalink, routing it based on the op field.

Parameters

Parameter	Type	Description	Optional
d	Buffer | string	The raw message data.

---

open()

warning

This method is protected and should not be called directly.

protected open(): void

Handles the WebSocket open event. Clears any pending reconnect timeout, emits nodeConnect, and moves any players currently on a backup node back to this node.

---

queueEnd()

async queueEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void>

Handles the end of a queue. If autoplay is enabled, attempts to find and play a recommended track up to autoplayTries times. Emits queueEnd if no track is found or autoplay is disabled.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
track	Track	The track that ended.
payload	TrackEndEvent	The track end payload.

---

setSponsorBlock()

warning

This method requires the SponsorBlock plugin to be installed on the Lavalink node.

async setSponsorBlock(player: Player, segments?: SponsorBlockSegment[]): Promise<void>

Sets the active SponsorBlock segment categories for a player. Defaults to [Sponsor, SelfPromo] if no segments are provided.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
segments	SponsorBlockSegment[]	The segment categories to activate. Defaults to [Sponsor, SelfPromo].

---

socketClosed()

warning

This method is protected and should not be called directly.

protected socketClosed(player: Player, payload: WebSocketClosedEvent): void

Handles the WebSocketClosedEvent from Lavalink, emitting socketClosed on the manager.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
payload	WebSocketClosedEvent	The payload.

---

trackEnd()

async trackEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void>

Handles a TrackEndEvent from Lavalink. Manages repeat logic, queue advancement, autoplay, and queue-end behaviour based on the end reason.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
track	Track	The track that ended.
payload	TrackEndEvent	The track end payload.

---

trackError()

warning

This method is protected and should not be called directly.

protected async trackError(player: Player, track: Track, payload: TrackExceptionEvent): Promise<void>

Handles a TrackExceptionEvent. Stops the player and emits trackError on the manager.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
track	Track	The track.
payload	TrackExceptionEvent	The payload.

---

trackStart()

warning

This method is protected and should not be called directly.

protected trackStart(player: Player, track: Track, payload: TrackStartEvent): void

Handles a TrackStartEvent. Updates player state and emits trackStart on the manager.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
track	Track	The track.
payload	TrackStartEvent	The payload.

---

trackStuck()

warning

This method is protected and should not be called directly.

protected async trackStuck(player: Player, track: Track, payload: TrackStuckEvent): Promise<void>

Handles a TrackStuckEvent. Stops the player and emits trackStuck on the manager.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
track	Track	The track.
payload	TrackStuckEvent	The payload.

---

updateSessionId()

async updateSessionId(): Promise<void>

Persists the current sessionId to the configured storage backend. For JSON/Memory storage, writes a per-node flat file. For Redis, updates a hash field keyed by identifier::clusterId.