Skip to content

LithiumX v1.0.8


LithiumX / LithiumXNode

Class: LithiumXNode

Defined in: src/Structures/Node.ts:18

Constructors

new LithiumXNode()

new LithiumXNode(options): LithiumXNode

Defined in: src/Structures/Node.ts:53

Creates an instance of Node.

Parameters

options

NodeOptions

Returns

LithiumXNode

Properties

manager

manager: LithiumXManager

Defined in: src/Structures/Node.ts:23


options

options: NodeOptions

Defined in: src/Structures/Node.ts:53


rest

readonly rest: LithiumXRest

Defined in: src/Structures/Node.ts:27

The REST instance.


sessionId

sessionId: string

Defined in: src/Structures/Node.ts:25

The node's session ID.


socket

socket: WebSocket = null

Defined in: src/Structures/Node.ts:20

The socket for the node.


stats

stats: NodeStats

Defined in: src/Structures/Node.ts:22

The stats for the node.

Accessors

address

Get Signature

get address(): string

Defined in: src/Structures/Node.ts:40

Returns the address for this node.

Returns

string


connected

Get Signature

get connected(): boolean

Defined in: src/Structures/Node.ts:34

Returns if connected to the Node.

Returns

boolean

Methods

connect()

connect(): void

Defined in: src/Structures/Node.ts:106

Connects to the Node.

Returns

void


destroy()

destroy(): void

Defined in: src/Structures/Node.ts:124

Destroys the Node and all players connected with it.

Returns

void


extractSpotifyArtistID()

extractSpotifyArtistID(url): string

Defined in: src/Structures/Node.ts:274

Parameters

url

string

Returns

string


extractSpotifyTrackID()

extractSpotifyTrackID(url): string

Defined in: src/Structures/Node.ts:268

Parameters

url

string

Returns

string