ManagerUtils

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

Constructors

Constructor

new ManagerUtils(LavalinkManager?: LavalinkManager): ManagerUtils;

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

Parameters

Parameter	Type
LavalinkManager?	LavalinkManager

Returns

ManagerUtils

Properties

Property	Modifier	Type	Default value	Defined in
LavalinkManager	public	LavalinkManager	undefined	src/structures/Utils.ts:43

Methods

buildPluginInfo()

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

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

Parameters

Parameter	Type
data	any
clientData	any

Returns

any

---

buildTrack()

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

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

Parameters

Parameter	Type
data	| Track | LavalinkTrack
requester	unknown

Returns

Track

---

buildUnresolvedTrack()

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

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

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:217

Parameters

Parameter	Type
data	UnresolvedTrack
player	Player

Returns

Promise<Track>

---

getTransformedRequester()

getTransformedRequester(requester: unknown): unknown;

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

Parameters

Parameter	Type
requester	unknown

Returns

unknown

---

isNode()

isNode(data: LavalinkNode): boolean;

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

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:173

Validate if a data is equal to node options

Parameters

Parameter	Type	Description
data	LavalinkNodeOptions

Returns

boolean

---

isTrack()

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

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

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:203

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:213

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:332

Parameters

Parameter	Type
query	LavaSearchQuery

Returns

object

Name	Type	Defined in
query	string	src/structures/Utils.ts:336
source	any	src/structures/Utils.ts:338
types	string[]	src/structures/Utils.ts:337

---

transformQuery()

transformQuery(query: SearchQuery): object;

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

Parameters

Parameter	Type
query	SearchQuery

Returns

object

Name	Type	Defined in
extraQueryUrlParams	URLSearchParams	src/structures/Utils.ts:320
query	string	src/structures/Utils.ts:319
source	any	src/structures/Utils.ts:321

---

validateQueryString()

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

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

Parameters

Parameter	Type
node	LavalinkNode
queryString	string
sourceString?	LavalinkSearchPlatform

Returns

void

---

validateSourceString()

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

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

Parameters

Parameter	Type
node	LavalinkNode
sourceString	SearchPlatform

Returns

void