ManagerUtils
Defined in: src/structures/Utils.ts:42
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ManagerUtils(LavalinkManager?: LavalinkManager): ManagerUtils;
Defined in: src/structures/Utils.ts:44
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
LavalinkManager? | LavalinkManager |
Returns
Section titled “Returns”ManagerUtils
Properties
Section titled “Properties”Property | Modifier | Type | Default value | Defined in |
---|---|---|---|---|
LavalinkManager | public | LavalinkManager | undefined | src/structures/Utils.ts:43 |
Methods
Section titled “Methods”buildPluginInfo()
Section titled “buildPluginInfo()”buildPluginInfo(data: any, clientData: any): any;
Defined in: src/structures/Utils.ts:48
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
data | any |
clientData | any |
Returns
Section titled “Returns”any
buildTrack()
Section titled “buildTrack()”buildTrack(data: | Track | LavalinkTrack, requester: unknown): Track;
Defined in: src/structures/Utils.ts:55
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
data | | Track | LavalinkTrack |
requester | unknown |
Returns
Section titled “Returns”buildUnresolvedTrack()
Section titled “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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
query | | UnresolvedTrack | UnresolvedQuery | |
requester | unknown |
Returns
Section titled “Returns”getClosestTrack()
Section titled “getClosestTrack()”getClosestTrack(data: UnresolvedTrack, player: Player): Promise<Track>;
Defined in: src/structures/Utils.ts:217
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
data | UnresolvedTrack |
player | Player |
Returns
Section titled “Returns”Promise
<Track
>
getTransformedRequester()
Section titled “getTransformedRequester()”getTransformedRequester(requester: unknown): unknown;
Defined in: src/structures/Utils.ts:152
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
requester | unknown |
Returns
Section titled “Returns”unknown
isNode()
Section titled “isNode()”isNode(data: LavalinkNode): boolean;
Defined in: src/structures/Utils.ts:142
Validate if a data is equal to a node
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
data | LavalinkNode |
Returns
Section titled “Returns”boolean
isNodeOptions()
Section titled “isNodeOptions()”isNodeOptions(data: LavalinkNodeOptions): boolean;
Defined in: src/structures/Utils.ts:173
Validate if a data is equal to node options
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
data | LavalinkNodeOptions |
Returns
Section titled “Returns”boolean
isTrack()
Section titled “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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
data | | UnresolvedTrack | Track | the Track to validate |
Returns
Section titled “Returns”data is Track
isUnresolvedTrack()
Section titled “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
Section titled “Parameters”Parameter | Type |
---|---|
data | | UnresolvedTrack | Track |
Returns
Section titled “Returns”data is UnresolvedTrack
isUnresolvedTrackQuery()
Section titled “isUnresolvedTrackQuery()”isUnresolvedTrackQuery(data: UnresolvedQuery): boolean;
Defined in: src/structures/Utils.ts:213
Checks if the provided argument is a valid UnresolvedTrack.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
data | UnresolvedQuery |
Returns
Section titled “Returns”boolean
transformLavaSearchQuery()
Section titled “transformLavaSearchQuery()”transformLavaSearchQuery(query: LavaSearchQuery): object;
Defined in: src/structures/Utils.ts:332
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
query | LavaSearchQuery |
Returns
Section titled “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()
Section titled “transformQuery()”transformQuery(query: SearchQuery): object;
Defined in: src/structures/Utils.ts:316
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
query | SearchQuery |
Returns
Section titled “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()
Section titled “validateQueryString()”validateQueryString( node: LavalinkNode, queryString: string, sourceString?: LavalinkSearchPlatform): void;
Defined in: src/structures/Utils.ts:234
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
node | LavalinkNode |
queryString | string |
sourceString? | LavalinkSearchPlatform |
Returns
Section titled “Returns”void
validateSourceString()
Section titled “validateSourceString()”validateSourceString(node: LavalinkNode, sourceString: SearchPlatform): void;
Defined in: src/structures/Utils.ts:349
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
node | LavalinkNode |
sourceString | SearchPlatform |
Returns
Section titled “Returns”void