Skip to content

LithiumX v1.0.8


LithiumX / TrackUtils

Class: abstract TrackUtils ​

Defined in: src/Structures/Utils.ts:16

Constructors ​

new TrackUtils() ​

new TrackUtils(): TrackUtils

Returns ​

TrackUtils

Properties ​

trackPartial ​

static trackPartial: string[] = null

Defined in: src/Structures/Utils.ts:17

Methods ​

build() ​

static build(data, requester?): Track

Defined in: src/Structures/Utils.ts:72

Builds a Track from the raw data from Lavalink and a optional requester.

Parameters ​

data ​

TrackData

The raw data from Lavalink.

requester? ​

string

The user who requested the track.

Returns ​

Track


buildUnresolved() ​

static buildUnresolved(query, requester?): UnresolvedTrack

Defined in: src/Structures/Utils.ts:123

Builds a UnresolvedTrack to be resolved before being played .

Parameters ​

query ​

The query to search for.

string | UnresolvedQuery

requester? ​

string

The user who requested the track.

Returns ​

UnresolvedTrack


getClosestTrack() ​

static getClosestTrack(unresolvedTrack): Promise<Track>

Defined in: src/Structures/Utils.ts:146

Parameters ​

unresolvedTrack ​

UnresolvedTrack

Returns ​

Promise<Track>


isTrack() ​

static isTrack(track): boolean

Defined in: src/Structures/Utils.ts:62

Checks if the provided argument is a valid Track.

Parameters ​

track ​

unknown

Returns ​

boolean


isUnresolvedTrack() ​

static isUnresolvedTrack(track): boolean

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

Checks if the provided argument is a valid UnresolvedTrack.

Parameters ​

track ​

unknown

Returns ​

boolean


setTrackPartial() ​

static setTrackPartial(partial): void

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

Parameters ​

partial ​

string[]

Returns ​

void


validate() ​

static validate(trackOrTracks): boolean

Defined in: src/Structures/Utils.ts:36

Checks if the provided argument is a valid Track or UnresolvedTrack, if provided an array then every element will be checked.

Parameters ​

trackOrTracks ​

unknown

Returns ​

boolean