distube 3.1.1 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/dist/DisTube.d.ts +38 -31
  2. package/dist/DisTube.d.ts.map +1 -1
  3. package/dist/DisTube.js +36 -25
  4. package/dist/DisTube.js.map +1 -1
  5. package/dist/constant.d.ts +1 -1
  6. package/dist/constant.js +1 -1
  7. package/dist/constant.js.map +1 -1
  8. package/dist/core/DisTubeHandler.js +8 -13
  9. package/dist/core/DisTubeHandler.js.map +1 -1
  10. package/dist/core/manager/BaseManager.d.ts +4 -4
  11. package/dist/core/manager/BaseManager.js.map +1 -1
  12. package/dist/core/manager/QueueManager.js +1 -2
  13. package/dist/core/manager/QueueManager.js.map +1 -1
  14. package/dist/core/voice/DJSAdapter.js +4 -7
  15. package/dist/core/voice/DJSAdapter.js.map +1 -1
  16. package/dist/core/voice/DisTubeVoice.js +4 -8
  17. package/dist/core/voice/DisTubeVoice.js.map +1 -1
  18. package/dist/core/voice/DisTubeVoiceManager.d.ts +4 -4
  19. package/dist/core/voice/DisTubeVoiceManager.js +2 -2
  20. package/dist/core/voice/DisTubeVoiceManager.js.map +1 -1
  21. package/dist/index.d.ts +1 -1
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index.js +2 -1
  24. package/dist/index.js.map +1 -1
  25. package/dist/plugin/https.js +1 -1
  26. package/dist/plugin/https.js.map +1 -1
  27. package/dist/plugin/youtube-dl.js +1 -2
  28. package/dist/plugin/youtube-dl.js.map +1 -1
  29. package/dist/struct/Playlist.js +3 -6
  30. package/dist/struct/Playlist.js.map +1 -1
  31. package/dist/struct/Queue.js +3 -6
  32. package/dist/struct/Queue.js.map +1 -1
  33. package/dist/struct/SearchResult.js +2 -3
  34. package/dist/struct/SearchResult.js.map +1 -1
  35. package/dist/struct/Song.js +8 -11
  36. package/dist/struct/Song.js.map +1 -1
  37. package/dist/struct/TaskQueue.js +1 -2
  38. package/dist/struct/TaskQueue.js.map +1 -1
  39. package/dist/tsconfig.tsbuildinfo +1 -1
  40. package/dist/type.d.ts +1 -1
  41. package/dist/type.js.map +1 -1
  42. package/dist/util.d.ts +2 -2
  43. package/dist/util.js +9 -14
  44. package/dist/util.js.map +1 -1
  45. package/package.json +1 -1
package/dist/DisTube.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import { TypedEmitter } from "tiny-typed-emitter";
2
2
  import { DisTubeHandler, DisTubeVoiceManager, Options, Playlist, Queue, QueueManager, SearchResult, Song } from ".";
3
3
  import type { Client, GuildMember, GuildTextBasedChannel, Message, VoiceBasedChannel } from "discord.js";
4
- import type { CustomPlugin, DisTubeEvents, DisTubeOptions, ExtractorPlugin, Filters, GuildIDResolvable } from ".";
4
+ import type { CustomPlugin, DisTubeEvents, DisTubeOptions, ExtractorPlugin, Filters, GuildIdResolvable } from ".";
5
+ export declare const version: string;
5
6
  /**
6
7
  * DisTube class
7
8
  * @extends EventEmitter
@@ -29,6 +30,12 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
29
30
  * client.login("Your Discord Bot Token")
30
31
  */
31
32
  constructor(client: Client, otp?: DisTubeOptions);
33
+ static get version(): string;
34
+ /**
35
+ * DisTube version
36
+ * @type {string}
37
+ */
38
+ get version(): string;
32
39
  /**
33
40
  * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
34
41
  *
@@ -59,7 +66,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
59
66
  * });
60
67
  * @returns {Promise<void>}
61
68
  */
62
- play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options: {
69
+ play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options?: {
63
70
  skip?: boolean;
64
71
  unshift?: boolean;
65
72
  member?: GuildMember;
@@ -82,7 +89,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
82
89
  * See {@link Song#metadata} or {@link Playlist#metadata}
83
90
  * @deprecated Message parameter is deprecated, use VoiceChannel instead. See {@link DisTube#play}
84
91
  */
85
- play(message: Message<true>, song: string | Song | SearchResult | Playlist, options: {
92
+ play(message: Message<true>, song: string | Song | SearchResult | Playlist, options?: {
86
93
  skip?: boolean;
87
94
  unshift?: boolean;
88
95
  metadata?: any;
@@ -185,7 +192,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
185
192
  }): Promise<Array<SearchResult>>;
186
193
  /**
187
194
  * Get the guild queue
188
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
195
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
189
196
  * @returns {Queue?}
190
197
  * @throws {Error}
191
198
  * @example
@@ -201,24 +208,24 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
201
208
  * }
202
209
  * });
203
210
  */
204
- getQueue(queue: GuildIDResolvable): Queue | undefined;
211
+ getQueue(queue: GuildIdResolvable): Queue | undefined;
205
212
  /**
206
213
  * Pause the guild stream
207
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
214
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
208
215
  * @returns {Queue} The guild queue
209
216
  * @throws {Error}
210
217
  */
211
- pause(queue: GuildIDResolvable): Queue;
218
+ pause(queue: GuildIdResolvable): Queue;
212
219
  /**
213
220
  * Resume the guild stream
214
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
221
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
215
222
  * @returns {Queue} The guild queue
216
223
  * @throws {Error}
217
224
  */
218
- resume(queue: GuildIDResolvable): Queue;
225
+ resume(queue: GuildIdResolvable): Queue;
219
226
  /**
220
227
  * Stop the guild stream
221
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
228
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
222
229
  * @returns {Promise<void>}
223
230
  * @throws {Error}
224
231
  * @example
@@ -232,10 +239,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
232
239
  * }
233
240
  * });
234
241
  */
235
- stop(queue: GuildIDResolvable): Promise<void>;
242
+ stop(queue: GuildIdResolvable): Promise<void>;
236
243
  /**
237
244
  * Set the guild stream's volume
238
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
245
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
239
246
  * @param {number} percent The percentage of volume you want to set
240
247
  * @returns {Queue} The guild queue
241
248
  * @throws {Error}
@@ -248,12 +255,12 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
248
255
  * distube.setVolume(message, Number(args[0]));
249
256
  * });
250
257
  */
251
- setVolume(queue: GuildIDResolvable, percent: number): Queue;
258
+ setVolume(queue: GuildIdResolvable, percent: number): Queue;
252
259
  /**
253
260
  * Skip the playing song if there is a next song in the queue.
254
261
  * <info>If {@link Queue#autoplay} is `true` and there is no up next song,
255
262
  * DisTube will add and play a related song.</info>
256
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
263
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
257
264
  * @returns {Promise<Song>} The new Song will be played
258
265
  * @throws {Error}
259
266
  * @example
@@ -265,10 +272,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
265
272
  * distube.skip(message);
266
273
  * });
267
274
  */
268
- skip(queue: GuildIDResolvable): Promise<Song>;
275
+ skip(queue: GuildIdResolvable): Promise<Song>;
269
276
  /**
270
277
  * Play the previous song
271
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
278
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
272
279
  * @returns {Promise<Song>} The new Song will be played
273
280
  * @throws {Error}
274
281
  * @example
@@ -280,10 +287,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
280
287
  * distube.previous(message);
281
288
  * });
282
289
  */
283
- previous(queue: GuildIDResolvable): Promise<Song>;
290
+ previous(queue: GuildIdResolvable): Promise<Song>;
284
291
  /**
285
292
  * Shuffle the guild queue songs
286
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
293
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
287
294
  * @returns {Promise<Queue>} The guild queue
288
295
  * @example
289
296
  * client.on('message', (message) => {
@@ -294,12 +301,12 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
294
301
  * distube.shuffle(message);
295
302
  * });
296
303
  */
297
- shuffle(queue: GuildIDResolvable): Promise<Queue>;
304
+ shuffle(queue: GuildIdResolvable): Promise<Queue>;
298
305
  /**
299
306
  * Jump to the song number in the queue.
300
307
  * The next one is 1, 2,...
301
308
  * The previous one is -1, -2,...
302
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
309
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
303
310
  * @param {number} num The song number to play
304
311
  * @returns {Promise<Queue>} The guild queue
305
312
  * @throws {Error} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
@@ -313,11 +320,11 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
313
320
  * .catch(err => message.channel.send("Invalid song number."));
314
321
  * });
315
322
  */
316
- jump(queue: GuildIDResolvable, num: number): Promise<Queue>;
323
+ jump(queue: GuildIdResolvable, num: number): Promise<Queue>;
317
324
  /**
318
325
  * Set the repeat mode of the guild queue.\
319
326
  * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
320
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
327
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
321
328
  * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
322
329
  * @returns {RepeatMode} The new repeat mode
323
330
  * @example
@@ -347,10 +354,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
347
354
  * }
348
355
  * message.channel.send("Set repeat mode to `" + mode + "`");
349
356
  */
350
- setRepeatMode(queue: GuildIDResolvable, mode?: number): number;
357
+ setRepeatMode(queue: GuildIdResolvable, mode?: number): number;
351
358
  /**
352
359
  * Toggle autoplay mode
353
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
360
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
354
361
  * @returns {boolean} Autoplay mode state
355
362
  * @throws {Error}
356
363
  * @example
@@ -364,17 +371,17 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
364
371
  * }
365
372
  * });
366
373
  */
367
- toggleAutoplay(queue: GuildIDResolvable): boolean;
374
+ toggleAutoplay(queue: GuildIdResolvable): boolean;
368
375
  /**
369
376
  * Add related song to the queue
370
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
377
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
371
378
  * @returns {Promise<Song>} The guild queue
372
379
  */
373
- addRelatedSong(queue: GuildIDResolvable): Promise<Song>;
380
+ addRelatedSong(queue: GuildIdResolvable): Promise<Song>;
374
381
  /**
375
382
  * Enable or disable filter(s) of the queue.
376
383
  * Available filters: {@link Filters}
377
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
384
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
378
385
  * @param {string|false} filter A filter name, `false` to clear all the filters
379
386
  * @param {boolean} [force=false] Force enable the input filter(s) even if it's enabled
380
387
  * @returns {Array<string>} Enabled filters.
@@ -389,10 +396,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
389
396
  * }
390
397
  * });
391
398
  */
392
- setFilter(queue: GuildIDResolvable, filter: string | false, force?: boolean): Array<string>;
399
+ setFilter(queue: GuildIdResolvable, filter: string | false, force?: boolean): Array<string>;
393
400
  /**
394
401
  * Set the playing time to another position
395
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
402
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
396
403
  * @param {number} time Time in seconds
397
404
  * @returns {Queue} Seeked queue
398
405
  * @example
@@ -404,7 +411,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
404
411
  * distube.seek(message, Number(args[0]));
405
412
  * });
406
413
  */
407
- seek(queue: GuildIDResolvable, time: number): Queue;
414
+ seek(queue: GuildIdResolvable, time: number): Queue;
408
415
  /**
409
416
  * Emit error event
410
417
  * @param {Error} error error
@@ -1 +1 @@
1
- {"version":3,"file":"DisTube.d.ts","sourceRoot":"","sources":["../src/DisTube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,cAAc,EACd,mBAAmB,EAGnB,OAAO,EACP,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,IAAI,EAQL,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAe,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAIlH;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;OAYG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAsDpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,EAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAChB;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAE,GAC7D,OAAO,CAAC,IAAI,CAAC;IA+GhB;;;;;;;;;;;;;;;;;;OAkBG;IACG,gBAAgB,CACpB,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAAE,EACvC,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,QAAQ,CAAC;IA4BpB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CACtB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAC1C,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EACpC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAO,GACtF,OAAO,CAAC,IAAI,CAAC;IAsChB;;;;;;;;;;;OAWG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACrG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAuB/B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS;IAIrD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;IAM3D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAMjD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAM3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAM9D;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOjD;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAMzF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;CAe/D;AAED,eAAe,OAAO,CAAC;AAEvB;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}
1
+ {"version":3,"file":"DisTube.d.ts","sourceRoot":"","sources":["../src/DisTube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,cAAc,EACd,mBAAmB,EAGnB,OAAO,EACP,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,IAAI,EAQL,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAe,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAMlH,eAAO,MAAQ,OAAO,QAAoD,CAAC;AAE3E;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;OAYG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAuDpD,MAAM,KAAK,OAAO,WAEjB;IAED;;;OAGG;IACH,IAAI,OAAO,WAEV;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAChB;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IA+GhB;;;;;;;;;;;;;;;;;;OAkBG;IACG,gBAAgB,CACpB,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,GAAG,IAAI,EACpD,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAAE,EACvC,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,QAAQ,CAAC;IA4BpB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CACtB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAC1C,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EACpC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAO,GACtF,OAAO,CAAC,IAAI,CAAC;IAsChB;;;;;;;;;;;OAWG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACrG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAuB/B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS;IAIrD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;IAM3D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAMjD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAM3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAM9D;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOjD;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAMzF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;CAe/D;AAED,eAAe,OAAO,CAAC;AAEvB;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}
package/dist/DisTube.js CHANGED
@@ -3,13 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DisTube = void 0;
6
+ exports.DisTube = exports.version = void 0;
7
7
  const ytpl_1 = __importDefault(require("@distube/ytpl"));
8
8
  const ytsr_1 = __importDefault(require("@distube/ytsr"));
9
9
  const util_1 = require("./util");
10
10
  const tiny_typed_emitter_1 = require("tiny-typed-emitter");
11
11
  const _1 = require(".");
12
12
  // TODO: remove deprecated stuff on the next major version
13
+ // Cannot be `import` as it's not under TS root dir
14
+ // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
15
+ exports.version = require("../package.json").version;
13
16
  /**
14
17
  * DisTube class
15
18
  * @extends EventEmitter
@@ -84,8 +87,17 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
84
87
  */
85
88
  this.customPlugins = this.options.plugins.filter((p) => p.type === "custom");
86
89
  }
90
+ static get version() {
91
+ return exports.version;
92
+ }
93
+ /**
94
+ * DisTube version
95
+ * @type {string}
96
+ */
97
+ get version() {
98
+ return exports.version;
99
+ }
87
100
  async play(voiceChannel, song, options = {}) {
88
- var _a, _b;
89
101
  if ((0, _1.isMessageInstance)(voiceChannel)) {
90
102
  process.emitWarning("Passing Message for DisTube#play is deprecated, use VoiceBasedChannel instead.", "DeprecationWarning");
91
103
  const message = voiceChannel;
@@ -136,7 +148,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
136
148
  let queue = this.getQueue(voiceChannel);
137
149
  const queuing = !!queue && !queue.taskQueue.hasResolveTask;
138
150
  if (queuing)
139
- await (queue === null || queue === void 0 ? void 0 : queue.taskQueue.queuing(true));
151
+ await queue?.taskQueue.queuing(true);
140
152
  try {
141
153
  if (song instanceof _1.SearchResult && song.type === "playlist")
142
154
  song = song.url;
@@ -155,7 +167,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
155
167
  if (song instanceof _1.Playlist) {
156
168
  await this.handler.handlePlaylist(voiceChannel, song, { textChannel, skip, unshift });
157
169
  }
158
- else if (!this.options.nsfw && song.age_restricted && !((_a = textChannel) === null || _a === void 0 ? void 0 : _a.nsfw)) {
170
+ else if (!this.options.nsfw && song.age_restricted && !textChannel?.nsfw) {
159
171
  throw new _1.DisTubeError("NON_NSFW");
160
172
  }
161
173
  else {
@@ -179,14 +191,14 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
179
191
  }
180
192
  finally {
181
193
  if (queuing)
182
- queue === null || queue === void 0 ? void 0 : queue.taskQueue.resolve();
194
+ queue?.taskQueue.resolve();
183
195
  }
184
196
  }
185
197
  catch (e) {
186
198
  if (!(e instanceof _1.DisTubeError)) {
187
199
  try {
188
200
  e.name = "PlayError";
189
- e.message = `${((_b = song) === null || _b === void 0 ? void 0 : _b.url) || song}\n${e.message}`;
201
+ e.message = `${song?.url || song}\n${e.message}`;
190
202
  }
191
203
  catch { }
192
204
  }
@@ -284,7 +296,6 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
284
296
  * @deprecated Use {@link DisTube#createCustomPlaylist} and {@link DisTube#play} instead
285
297
  */
286
298
  async playCustomPlaylist(message, songs, properties = {}, options = {}) {
287
- var _a, _b, _c;
288
299
  process.emitWarning("DisTube#playCustomPlaylist is deprecated, use DisTube#createCustomPlaylist and DisTube#play instead.", "DeprecationWarning");
289
300
  try {
290
301
  if (typeof options !== "object" || Array.isArray(options)) {
@@ -298,22 +309,22 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
298
309
  const queue = this.getQueue(message);
299
310
  const queuing = queue && !queue.taskQueue.hasResolveTask;
300
311
  if (queuing)
301
- await (queue === null || queue === void 0 ? void 0 : queue.taskQueue.queuing(true));
312
+ await queue?.taskQueue.queuing(true);
302
313
  try {
303
314
  const playlist = await this.createCustomPlaylist(songs, {
304
- member: (_a = message.member) !== null && _a !== void 0 ? _a : undefined,
315
+ member: message.member ?? undefined,
305
316
  properties,
306
317
  parallel,
307
318
  metadata,
308
319
  });
309
- const voice = (_c = (_b = message.member) === null || _b === void 0 ? void 0 : _b.voice) === null || _c === void 0 ? void 0 : _c.channel;
320
+ const voice = message.member?.voice?.channel;
310
321
  if (!voice)
311
322
  throw new _1.DisTubeError("NOT_IN_VOICE");
312
323
  await this.play(voice, playlist, { textChannel: message.channel, skip, unshift, metadata });
313
324
  }
314
325
  finally {
315
326
  if (queuing)
316
- queue === null || queue === void 0 ? void 0 : queue.taskQueue.resolve();
327
+ queue?.taskQueue.resolve();
317
328
  }
318
329
  }
319
330
  catch (e) {
@@ -360,7 +371,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
360
371
  }
361
372
  /**
362
373
  * Get the guild queue
363
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
374
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
364
375
  * @returns {Queue?}
365
376
  * @throws {Error}
366
377
  * @example
@@ -381,7 +392,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
381
392
  }
382
393
  /**
383
394
  * Pause the guild stream
384
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
395
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
385
396
  * @returns {Queue} The guild queue
386
397
  * @throws {Error}
387
398
  */
@@ -393,7 +404,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
393
404
  }
394
405
  /**
395
406
  * Resume the guild stream
396
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
407
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
397
408
  * @returns {Queue} The guild queue
398
409
  * @throws {Error}
399
410
  */
@@ -405,7 +416,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
405
416
  }
406
417
  /**
407
418
  * Stop the guild stream
408
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
419
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
409
420
  * @returns {Promise<void>}
410
421
  * @throws {Error}
411
422
  * @example
@@ -427,7 +438,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
427
438
  }
428
439
  /**
429
440
  * Set the guild stream's volume
430
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
441
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
431
442
  * @param {number} percent The percentage of volume you want to set
432
443
  * @returns {Queue} The guild queue
433
444
  * @throws {Error}
@@ -450,7 +461,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
450
461
  * Skip the playing song if there is a next song in the queue.
451
462
  * <info>If {@link Queue#autoplay} is `true` and there is no up next song,
452
463
  * DisTube will add and play a related song.</info>
453
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
464
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
454
465
  * @returns {Promise<Song>} The new Song will be played
455
466
  * @throws {Error}
456
467
  * @example
@@ -470,7 +481,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
470
481
  }
471
482
  /**
472
483
  * Play the previous song
473
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
484
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
474
485
  * @returns {Promise<Song>} The new Song will be played
475
486
  * @throws {Error}
476
487
  * @example
@@ -490,7 +501,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
490
501
  }
491
502
  /**
492
503
  * Shuffle the guild queue songs
493
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
504
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
494
505
  * @returns {Promise<Queue>} The guild queue
495
506
  * @example
496
507
  * client.on('message', (message) => {
@@ -511,7 +522,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
511
522
  * Jump to the song number in the queue.
512
523
  * The next one is 1, 2,...
513
524
  * The previous one is -1, -2,...
514
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
525
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
515
526
  * @param {number} num The song number to play
516
527
  * @returns {Promise<Queue>} The guild queue
517
528
  * @throws {Error} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
@@ -534,7 +545,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
534
545
  /**
535
546
  * Set the repeat mode of the guild queue.\
536
547
  * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
537
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
548
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
538
549
  * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
539
550
  * @returns {RepeatMode} The new repeat mode
540
551
  * @example
@@ -572,7 +583,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
572
583
  }
573
584
  /**
574
585
  * Toggle autoplay mode
575
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
586
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
576
587
  * @returns {boolean} Autoplay mode state
577
588
  * @throws {Error}
578
589
  * @example
@@ -595,7 +606,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
595
606
  }
596
607
  /**
597
608
  * Add related song to the queue
598
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
609
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
599
610
  * @returns {Promise<Song>} The guild queue
600
611
  */
601
612
  addRelatedSong(queue) {
@@ -607,7 +618,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
607
618
  /**
608
619
  * Enable or disable filter(s) of the queue.
609
620
  * Available filters: {@link Filters}
610
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
621
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
611
622
  * @param {string|false} filter A filter name, `false` to clear all the filters
612
623
  * @param {boolean} [force=false] Force enable the input filter(s) even if it's enabled
613
624
  * @returns {Array<string>} Enabled filters.
@@ -630,7 +641,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
630
641
  }
631
642
  /**
632
643
  * Set the playing time to another position
633
- * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
644
+ * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
634
645
  * @param {number} time Time in seconds
635
646
  * @returns {Queue} Seeked queue
636
647
  * @example