ManagerUtils

Constructors

Constructor

new ManagerUtils(LavalinkManager?: LavalinkManager): ManagerUtils;

Defined in: src/structures/Utils.ts:47

Parameters

Parameter	Type
`LavalinkManager?`	`LavalinkManager`

Returns

ManagerUtils

Properties

Property (defined in)	Type	Default value
`LavalinkManager` (src/structures/Utils.ts:46)	`LavalinkManager`<`Player`>	`undefined`

Methods

buildPluginInfo()

buildPluginInfo(data: any, clientData?: any): any;

Defined in: src/structures/Utils.ts:51

Parameters

Parameter	Type
`data`	`any`
`clientData`	`any`

Returns

any

buildTrack()

buildTrack(data:
  | Track
  | LavalinkTrack, requester: unknown): Track;

Defined in: src/structures/Utils.ts:58

Parameters

Parameter	Type
`data`	\| `Track` \| `LavalinkTrack`
`requester`	`unknown`

Returns

Track

buildUnresolvedTrack()

buildUnresolvedTrack(query:
  | UnresolvedTrack
  | UnresolvedQuery, requester: unknown): UnresolvedTrack;

Defined in: src/structures/Utils.ts:115

Builds a UnresolvedTrack to be resolved before being played .

Parameters

Parameter	Type	Description
`query`	\| `UnresolvedTrack` \| `UnresolvedQuery`	-
`requester`	`unknown`	-

Returns

UnresolvedTrack

getClosestTrack()

getClosestTrack(data: UnresolvedTrack, player: Player): Promise<Track>;

Defined in: src/structures/Utils.ts:301

Parameters

Parameter	Type
`data`	`UnresolvedTrack`
`player`	`Player`

Returns

Promise<Track>

getTransformedRequester()

getTransformedRequester(requester: unknown): unknown;

Defined in: src/structures/Utils.ts:179

Parameters

Parameter	Type
`requester`	`unknown`

Returns

unknown

isNode()

isNode(data: LavalinkNode): boolean;

Defined in: src/structures/Utils.ts:154

Validate if a data is equal to a node

Parameters

Parameter	Type	Description
`data`	`LavalinkNode`	-

Returns

boolean

isNodeOptions()

isNodeOptions(data: LavalinkNodeOptions): boolean;

Defined in: src/structures/Utils.ts:201

Validate if a data is equal to node options

Parameters

Parameter	Type	Description
`data`	`LavalinkNodeOptions`	-

Returns

boolean

isNotBrokenTrack()

isNotBrokenTrack(data:
  | UnresolvedTrack
  | Track, minDuration?: number): data is Track;

Defined in: src/structures/Utils.ts:258

Validate tracks based on duration whether they are playble or broken tracks. most tracks should be longer than 30s, so you can put a minDuration of 29e3 (cause preview tracks are exactly 30s) or put 0. This check is not done automatically, you need to check it yourself by doing:

Parameters

Parameter	Type	Default value
`data`	\| `UnresolvedTrack` \| `Track`	`undefined`
`minDuration`	`number`	`29e3`

Returns

data is Track

Example

const res = await player.search("Adele");

// short hand:
const validTracks = res.tracks.filter(client.lavalink.utils.isNotBrokenTrack)
// or with options:
const validTracks = res.tracks.filter(t => client.lavalink.utils.isNotBrokenTrack(t, 29e3));

// then you can add it to the queue.
await player.queue.add(validTracks);

isTrack()

isTrack(data:
  | UnresolvedTrack
  | Track): data is Track;

Defined in: src/structures/Utils.ts:272

Validate if a data is equal to a track

Parameters

Parameter	Type	Description
`data`	\| `UnresolvedTrack` \| `Track`	the Track to validate

Returns

data is Track

isUnresolvedTrack()

isUnresolvedTrack(data:
  | UnresolvedTrack
  | Track): data is UnresolvedTrack;

Defined in: src/structures/Utils.ts:282

Checks if the provided argument is a valid UnresolvedTrack.

Parameters

Parameter	Type
`data`	\| `UnresolvedTrack` \| `Track`

Returns

data is UnresolvedTrack

isUnresolvedTrackQuery()

isUnresolvedTrackQuery(data: UnresolvedQuery): boolean;

Defined in: src/structures/Utils.ts:297

Checks if the provided argument is a valid UnresolvedTrack.

Parameters

Parameter	Type
`data`	`UnresolvedQuery`

Returns

boolean

transformLavaSearchQuery()

transformLavaSearchQuery(query: LavaSearchQuery): object;

Defined in: src/structures/Utils.ts:457

Parameters

Parameter	Type
`query`	`LavaSearchQuery`

Returns

object

Name	Type	Defined in
`query`	`string`	src/structures/Utils.ts:467
`source`	`any`	src/structures/Utils.ts:473
`types`	`string`[]	src/structures/Utils.ts:468

transformQuery()

transformQuery(query: SearchQuery): object;

Defined in: src/structures/Utils.ts:431

Parameters

Parameter	Type
`query`	`SearchQuery`

Returns

object

Name	Type	Defined in
`extraQueryUrlParams`	`URLSearchParams`	src/structures/Utils.ts:441
`query`	`string`	src/structures/Utils.ts:440
`source`	`any`	src/structures/Utils.ts:442

validateQueryString()

validateQueryString(
   node: LavalinkNode,
   queryString: string,
   sourceString?: LavalinkSearchPlatform): void;

Defined in: src/structures/Utils.ts:317

Parameters

Parameter	Type
`node`	`LavalinkNode`
`queryString`	`string`
`sourceString?`	`LavalinkSearchPlatform`

Returns

void

validateSourceString()

validateSourceString(node: LavalinkNode, sourceString: SearchPlatform): void;

Defined in: src/structures/Utils.ts:488

Parameters

Parameter	Type
`node`	`LavalinkNode`
`sourceString`	`SearchPlatform`

Returns

void