Node

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class Node {}

Properties

Property	Type	Description
info	LavalinkInfo	The node info.
isNodeLink	boolean	Whether the node is a node link.
rest	Rest	The rest instance.
sessionId	string	The session ID.
socket	WebSocket	The socket.
stats	NodeStats	The node stats.

Constructor

new Node(manager: Manager, options: NodeOptions)

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

Methods

address()

address(): string

Returns the full address for this node, including the host and port.

---

connect()

async connect(): Promise<void>

Connects to the node.

---

connected()

connected(): boolean

Checks if the Node is currently connected.

---

createSessionIdsFile()

createSessionIdsFile(): void

Creates a session ids file for this node.

---

deleteSponsorBlock()

warning

⚠️ This method only works when the node has the sponsor block plugin.

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

Deletes the sponsor block for this node.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.

---

error()

warning

⚠️ This method is protected and should not be called directly.

error(error: Error): void

Handles an error.

Parameters

Parameter	Type	Description	Optional
error	Error	The error.

---

fetchInfo()

async fetchInfo(): Promise<LavalinkInfo>

Fetches the info for this node.

Returns

Type	Description
Promise<LavalinkInfo>	The node info.

---

getLyrics()

warning

⚠️ This method only works when the node has the LavaLyrics plugin.
Or the node is a NodeLink node.

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

Gets the lyrics for a track.

Parameters

Parameter	Type	Description	Optional
track	Track	The track.
skipTrackSource	boolean	Whether to skip the track source.
language	string	The language.

Returns

Type	Description
Promise<Lyrics | NodeLinkGetLyrics>	The lyrics.

---

getSponsorBlock()

warning

⚠️ This method only works when the node has the sponsor block plugin.

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

Gets the sponsor block for this node.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.

Returns

Type	Description
Promise<SponsorBlockSegment[]>	The sponsor block.

---

handleEvent()

warning

⚠️ This method is protected and should not be called directly.

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

Handles an event emitted from the Lavalink node.

Parameters

Parameter	Type	Description	Optional
payload	PlayerEvent | PlayerEvents	The payload.

---

loadSessionIds()

async loadSessionIds(): Promise<void>

Loads the session ids for this node.

---

lyricsSubscribe()

warning

⚠️ This method only works when the node has the LavaLyrics plugin.

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

Subscribes to lyrics for a guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID.
skipTrackSource	boolean	Whether to skip the track source.

Returns

Type	Description
Promise<unknown>	The promise that resolves to the response.

---

lyricsUnsubscribe()

warning

⚠️ This method only works when the node has the LavaLyrics plugin.

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

Unsubscribes from lyrics for a guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

message()

warning

⚠️ This method is protected and should not be called directly.

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

Sends a message to the node.

Parameters

Parameter	Type	Description	Optional
d	Buffer | string	The data to send.

open()

warning

⚠️ This method is protected and should not be called directly.

open(): void

Opens the connection to the node.

queueEnd()

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

Handles the event when a queue ends.

Parameters

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

---

setSponsorBlock()

warning

⚠️ This method only works when the node has the sponsor block plugin.

async setSponsorBlock(player: Player, segments: SponsorBlockSegment[] = [SponsorBlockSegment.Sponsor, SponsorBlockSegment.SelfPromo]): Promise<void>

Sets the sponsorblock segments for a player.

Parameters

Parameter	Type	Description	Optional
player	Player	The player.
segments	SponsorBlockSegment[]	The segments.

---

socketClosed()

warning

⚠️ This method is protected and should not be called directly.

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

Emitted when the WebSocket connection for a player closes.

Parameters

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

---

trackEnd()

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

Emitted when a track ends playing.

Parameters

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

---

trackError()

warning

⚠️ This method is protected and should not be called directly.

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

Handles the event when a track has an error during playback.

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.

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

Emitted when a new track starts playing.

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.

trackStuck(player: Player, track: Track, payload: TrackStuckEvent): void

Emitted when a track gets stuck.

Parameters

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

---

updateSessionId()

updateSessionId(): void

Updates the session ID.