distube 3.0.7 → 3.2.1

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 (107) hide show
  1. package/dist/DisTube.d.ts +133 -65
  2. package/dist/DisTube.d.ts.map +1 -1
  3. package/dist/DisTube.js +161 -103
  4. package/dist/DisTube.js.map +1 -1
  5. package/dist/constant.d.ts +14 -15
  6. package/dist/constant.d.ts.map +1 -1
  7. package/dist/constant.js +14 -15
  8. package/dist/constant.js.map +1 -1
  9. package/dist/core/DisTubeBase.d.ts +3 -4
  10. package/dist/core/DisTubeBase.d.ts.map +1 -1
  11. package/dist/core/DisTubeBase.js +1 -2
  12. package/dist/core/DisTubeBase.js.map +1 -1
  13. package/dist/core/DisTubeHandler.d.ts +37 -25
  14. package/dist/core/DisTubeHandler.d.ts.map +1 -1
  15. package/dist/core/DisTubeHandler.js +72 -68
  16. package/dist/core/DisTubeHandler.js.map +1 -1
  17. package/dist/core/DisTubeOptions.d.ts +1 -2
  18. package/dist/core/DisTubeOptions.d.ts.map +1 -1
  19. package/dist/core/DisTubeOptions.js +64 -58
  20. package/dist/core/DisTubeOptions.js.map +1 -1
  21. package/dist/core/DisTubeStream.d.ts +1 -1
  22. package/dist/core/DisTubeStream.d.ts.map +1 -1
  23. package/dist/core/DisTubeStream.js +0 -1
  24. package/dist/core/DisTubeStream.js.map +1 -1
  25. package/dist/core/index.d.ts +2 -2
  26. package/dist/core/index.d.ts.map +1 -1
  27. package/dist/core/index.js +2 -2
  28. package/dist/core/index.js.map +1 -1
  29. package/dist/core/manager/BaseManager.d.ts +11 -7
  30. package/dist/core/manager/BaseManager.d.ts.map +1 -1
  31. package/dist/core/manager/BaseManager.js +11 -13
  32. package/dist/core/manager/BaseManager.js.map +1 -1
  33. package/dist/core/manager/QueueManager.d.ts +11 -38
  34. package/dist/core/manager/QueueManager.d.ts.map +1 -1
  35. package/dist/core/manager/QueueManager.js +115 -129
  36. package/dist/core/manager/QueueManager.js.map +1 -1
  37. package/dist/core/voice/DJSAdapter.js +4 -7
  38. package/dist/core/voice/DJSAdapter.js.map +1 -1
  39. package/dist/core/voice/DisTubeVoice.d.ts +10 -13
  40. package/dist/core/voice/DisTubeVoice.d.ts.map +1 -1
  41. package/dist/core/voice/DisTubeVoice.js +39 -28
  42. package/dist/core/voice/DisTubeVoice.js.map +1 -1
  43. package/dist/core/voice/DisTubeVoiceManager.d.ts +10 -10
  44. package/dist/core/voice/DisTubeVoiceManager.d.ts.map +1 -1
  45. package/dist/core/voice/DisTubeVoiceManager.js +6 -6
  46. package/dist/core/voice/DisTubeVoiceManager.js.map +1 -1
  47. package/dist/index.d.ts +1 -1
  48. package/dist/index.d.ts.map +1 -1
  49. package/dist/index.js +2 -1
  50. package/dist/index.js.map +1 -1
  51. package/dist/plugin/http.d.ts +5 -3
  52. package/dist/plugin/http.d.ts.map +1 -1
  53. package/dist/plugin/http.js +3 -5
  54. package/dist/plugin/http.js.map +1 -1
  55. package/dist/plugin/https.d.ts +10 -5
  56. package/dist/plugin/https.d.ts.map +1 -1
  57. package/dist/plugin/https.js +6 -9
  58. package/dist/plugin/https.js.map +1 -1
  59. package/dist/plugin/youtube-dl.d.ts +5 -4
  60. package/dist/plugin/youtube-dl.d.ts.map +1 -1
  61. package/dist/plugin/youtube-dl.js +6 -11
  62. package/dist/plugin/youtube-dl.js.map +1 -1
  63. package/dist/struct/CustomPlugin.d.ts +37 -17
  64. package/dist/struct/CustomPlugin.d.ts.map +1 -1
  65. package/dist/struct/CustomPlugin.js +18 -19
  66. package/dist/struct/CustomPlugin.js.map +1 -1
  67. package/dist/struct/DisTubeError.d.ts +4 -3
  68. package/dist/struct/DisTubeError.d.ts.map +1 -1
  69. package/dist/struct/DisTubeError.js +5 -7
  70. package/dist/struct/DisTubeError.js.map +1 -1
  71. package/dist/struct/ExtractorPlugin.d.ts +25 -15
  72. package/dist/struct/ExtractorPlugin.d.ts.map +1 -1
  73. package/dist/struct/ExtractorPlugin.js +14 -16
  74. package/dist/struct/ExtractorPlugin.js.map +1 -1
  75. package/dist/struct/Playlist.d.ts +24 -8
  76. package/dist/struct/Playlist.d.ts.map +1 -1
  77. package/dist/struct/Playlist.js +27 -14
  78. package/dist/struct/Playlist.js.map +1 -1
  79. package/dist/struct/Plugin.d.ts +4 -12
  80. package/dist/struct/Plugin.d.ts.map +1 -1
  81. package/dist/struct/Plugin.js +1 -11
  82. package/dist/struct/Plugin.js.map +1 -1
  83. package/dist/struct/Queue.d.ts +5 -6
  84. package/dist/struct/Queue.d.ts.map +1 -1
  85. package/dist/struct/Queue.js +5 -9
  86. package/dist/struct/Queue.js.map +1 -1
  87. package/dist/struct/SearchResult.d.ts +0 -1
  88. package/dist/struct/SearchResult.d.ts.map +1 -1
  89. package/dist/struct/SearchResult.js +2 -4
  90. package/dist/struct/SearchResult.js.map +1 -1
  91. package/dist/struct/Song.d.ts +26 -10
  92. package/dist/struct/Song.d.ts.map +1 -1
  93. package/dist/struct/Song.js +37 -25
  94. package/dist/struct/Song.js.map +1 -1
  95. package/dist/struct/TaskQueue.d.ts +1 -6
  96. package/dist/struct/TaskQueue.d.ts.map +1 -1
  97. package/dist/struct/TaskQueue.js +13 -7
  98. package/dist/struct/TaskQueue.js.map +1 -1
  99. package/dist/tsconfig.tsbuildinfo +1 -1
  100. package/dist/type.d.ts +12 -12
  101. package/dist/type.d.ts.map +1 -1
  102. package/dist/type.js.map +1 -1
  103. package/dist/util.d.ts +7 -6
  104. package/dist/util.d.ts.map +1 -1
  105. package/dist/util.js +23 -24
  106. package/dist/util.js.map +1 -1
  107. package/package.json +7 -8
package/dist/DisTube.d.ts CHANGED
@@ -1,20 +1,21 @@
1
1
  import { TypedEmitter } from "tiny-typed-emitter";
2
- import { DisTubeHandler, DisTubeVoiceManager, Options, Playlist, Queue, QueueManager, SearchResult } from ".";
3
- import type { Client, GuildMember, Message, StageChannel, TextChannel, VoiceChannel } from "discord.js";
4
- import type { CustomPlugin, DisTubeEvents, DisTubeOptions, ExtractorPlugin, Filters, GuildIDResolvable, Song } from ".";
2
+ import { DisTubeHandler, DisTubeVoiceManager, Options, Playlist, Queue, QueueManager, SearchResult, Song } from ".";
3
+ import type { Client, GuildMember, GuildTextBasedChannel, Message, VoiceBasedChannel } from "discord.js";
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
8
9
  */
9
10
  export declare class DisTube extends TypedEmitter<DisTubeEvents> {
10
- handler: DisTubeHandler;
11
- options: Options;
12
- client: Client;
13
- queues: QueueManager;
14
- voices: DisTubeVoiceManager;
15
- extractorPlugins: ExtractorPlugin[];
16
- customPlugins: CustomPlugin[];
17
- filters: Filters;
11
+ readonly handler: DisTubeHandler;
12
+ readonly options: Options;
13
+ readonly client: Client;
14
+ readonly queues: QueueManager;
15
+ readonly voices: DisTubeVoiceManager;
16
+ readonly extractorPlugins: ExtractorPlugin[];
17
+ readonly customPlugins: CustomPlugin[];
18
+ readonly filters: Filters;
18
19
  /**
19
20
  * Create a new DisTube class.
20
21
  * @param {Discord.Client} client Discord.JS client
@@ -29,34 +30,75 @@ 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;
32
34
  /**
33
- * Shorthand method for {@link DisTube#playVoiceChannel}
34
- * @returns {Promise<void>}
35
- * @param {Discord.Message} message A message from guild channel
35
+ * DisTube version
36
+ * @type {string}
37
+ */
38
+ get version(): string;
39
+ /**
40
+ * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
41
+ *
42
+ * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
36
43
  * @param {string|Song|SearchResult|Playlist} song URL | Search string |
37
44
  * {@link Song} | {@link SearchResult} | {@link Playlist}
38
45
  * @param {Object} [options] Optional options
39
46
  * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
40
47
  * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
41
48
  * (after the playing song if exists)
49
+ * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
50
+ * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
51
+ * @param {Discord.Message} [options.message] Called message (For built-in search events. If this is a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy|falsy value}, it will play the first result instead)
52
+ * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
53
+ * This is useful for identification purposes when the song/playlist is passed around in events.
54
+ * See {@link Song#metadata} or {@link Playlist#metadata}
42
55
  * @example
43
56
  * client.on('message', (message) => {
44
57
  * if (!message.content.startsWith(config.prefix)) return;
45
58
  * const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
46
59
  * const command = args.shift();
47
60
  * if (command == "play")
48
- * distube.play(message, args.join(" "));
61
+ * distube.play(message.member.voice?.channel, args.join(" "), {
62
+ * member: message.member,
63
+ * textChannel: message.channel,
64
+ * message
65
+ * });
49
66
  * });
67
+ * @returns {Promise<void>}
50
68
  */
51
- play(message: Message, song: string | Song | SearchResult | Playlist, options?: {
69
+ play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options?: {
52
70
  skip?: boolean;
53
71
  unshift?: boolean;
72
+ member?: GuildMember;
73
+ textChannel?: GuildTextBasedChannel;
74
+ message?: Message;
75
+ metadata?: any;
54
76
  }): Promise<void>;
55
77
  /**
56
78
  * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
57
- * Emit {@link DisTube#addList}, {@link DisTube#addSong} or {@link DisTube#playSong} after executing
79
+ *
80
+ * @param {Discord.Message} message A message from guild channel
81
+ * @param {string|Song|SearchResult|Playlist} song URL | Search string |
82
+ * {@link Song} | {@link SearchResult} | {@link Playlist}
83
+ * @param {Object} [options] Optional options
84
+ * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
85
+ * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
86
+ * (after the playing song if exists)
87
+ * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
88
+ * This is useful for identification purposes when the song/playlist is passed around in events.
89
+ * See {@link Song#metadata} or {@link Playlist#metadata}
90
+ * @deprecated Message parameter is deprecated, use VoiceChannel instead. See {@link DisTube#play}
91
+ */
92
+ play(message: Message<true>, song: string | Song | SearchResult | Playlist, options?: {
93
+ skip?: boolean;
94
+ unshift?: boolean;
95
+ metadata?: any;
96
+ }): Promise<void>;
97
+ /**
98
+ * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
99
+ *
58
100
  * @returns {Promise<void>}
59
- * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
101
+ * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
60
102
  * @param {string|Song|SearchResult|Playlist} song URL | Search string |
61
103
  * {@link Song} | {@link SearchResult} | {@link Playlist}
62
104
  * @param {Object} [options] Optional options
@@ -64,21 +106,50 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
64
106
  * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
65
107
  * (after the playing song if exists)
66
108
  * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
67
- * @param {Discord.TextChannel} [options.textChannel] Default {@link Queue#textChannel} (if the queue wasn't created)
109
+ * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
68
110
  * @param {Discord.Message} [options.message] Called message (For built-in search events. If this is a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy|falsy value}, it will play the first result instead)
111
+ * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
112
+ * This is useful for identification purposes when the song/playlist is passed around in events.
113
+ * See {@link Song#metadata} or {@link Playlist#metadata}
114
+ * @deprecated Use {@link DisTube#play} instead
69
115
  */
70
- playVoiceChannel(voiceChannel: VoiceChannel | StageChannel, song: string | Song | SearchResult | Playlist | null, options?: {
116
+ playVoiceChannel(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist | null, options?: {
71
117
  skip?: boolean;
72
118
  unshift?: boolean;
73
119
  member?: GuildMember;
74
- textChannel?: TextChannel;
120
+ textChannel?: GuildTextBasedChannel;
75
121
  message?: Message;
122
+ metadata?: any;
76
123
  }): Promise<void>;
77
124
  /**
78
- * <info>Shorthand method of {@link DisTubeHandler#createCustomPlaylist} and {@link DisTube#playVoiceChannel}
125
+ * Create a custom playlist
126
+ * @returns {Promise<Playlist>}
127
+ * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
128
+ * @param {Object} [options] Optional options
129
+ * @param {Discord.GuildMember} [options.message] A message from guild channel | A guild member
130
+ * @param {Object} [options.properties={}] Additional properties such as `name`
131
+ * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
132
+ * @param {*} [options.metadata] Metadata
133
+ * @example
134
+ * const songs = ["https://www.youtube.com/watch?v=xxx", "https://www.youtube.com/watch?v=yyy"];
135
+ * const playlist = await distube.createCustomPlaylist(songs, {
136
+ * member: message.member,
137
+ * properties: { name: "My playlist name" },
138
+ * parallel: true
139
+ * });
140
+ * distube.play(voiceChannel, playlist, { ... });
141
+ */
142
+ createCustomPlaylist(songs: (string | Song | SearchResult)[], options?: {
143
+ member?: GuildMember;
144
+ properties?: Record<string, any>;
145
+ parallel?: boolean;
146
+ metadata?: any;
147
+ }): Promise<Playlist>;
148
+ /**
149
+ * <info>Shorthand method of {@link DisTube#createCustomPlaylist} and {@link DisTube#play}
79
150
  *
80
151
  * If you doesn't have a user message (interaction,...),
81
- * see {@link DisTubeHandler#createCustomPlaylist} example</info>
152
+ * see {@link DisTube#createCustomPlaylist} example</info>
82
153
  *
83
154
  * Play or add array of video urls.
84
155
  * {@link DisTube#event:playSong} or {@link DisTube#event:addList} will be emitted
@@ -87,27 +158,24 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
87
158
  * @returns {Promise<void>}
88
159
  * @param {Discord.Message} message A message from guild channel
89
160
  * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
90
- * @param {Object} [properties={}] Additional properties such as `name`
161
+ * @param {Object} [properties={}] Additional properties for playlist such as `name`
91
162
  * @param {Object} [options] Optional options
92
163
  * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
93
164
  * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
94
165
  * (after the playing song if exists)
95
166
  * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
96
- * @example
97
- * const songs = ["https://www.youtube.com/watch?v=xxx", "https://www.youtube.com/watch?v=yyy"];
98
- * distube.playCustomPlaylist(message, songs, { name: "My playlist name" });
99
- * // Fetching custom playlist sequentially (reduce lag for low specs)
100
- * distube.playCustomPlaylist(message, songs, { name: "My playlist name" }, false, false);
167
+ * @deprecated Use {@link DisTube#createCustomPlaylist} and {@link DisTube#play} instead
101
168
  */
102
- playCustomPlaylist(message: Message, songs: Array<string | Song | SearchResult>, properties?: any, options?: {
169
+ playCustomPlaylist(message: Message<true>, songs: Array<string | Song | SearchResult>, properties?: Record<string, any>, options?: {
103
170
  skip?: boolean;
104
171
  unshift?: boolean;
105
172
  parallel?: boolean;
173
+ metadata?: any;
106
174
  }): Promise<void>;
107
175
  /**
108
- * Search for a song.
109
- * You can customize how user answers instead of send a number.
110
- * Then use {@link DisTube#play} or {@link DisTube#playVoiceChannel} to play it.
176
+ * Search for a song. You can customize how user answers instead of send a number.
177
+ * Then use {@link DisTube#play} to play it.
178
+ *
111
179
  * @param {string} string The string search for
112
180
  * @param {Object} options Search options
113
181
  * @param {number} [options.limit=10] Limit the results
@@ -124,7 +192,7 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
124
192
  }): Promise<Array<SearchResult>>;
125
193
  /**
126
194
  * Get the guild queue
127
- * @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}
128
196
  * @returns {Queue?}
129
197
  * @throws {Error}
130
198
  * @example
@@ -140,24 +208,24 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
140
208
  * }
141
209
  * });
142
210
  */
143
- getQueue(queue: GuildIDResolvable): Queue | undefined;
211
+ getQueue(queue: GuildIdResolvable): Queue | undefined;
144
212
  /**
145
213
  * Pause the guild stream
146
- * @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}
147
215
  * @returns {Queue} The guild queue
148
216
  * @throws {Error}
149
217
  */
150
- pause(queue: GuildIDResolvable): Queue;
218
+ pause(queue: GuildIdResolvable): Queue;
151
219
  /**
152
220
  * Resume the guild stream
153
- * @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}
154
222
  * @returns {Queue} The guild queue
155
223
  * @throws {Error}
156
224
  */
157
- resume(queue: GuildIDResolvable): Queue;
225
+ resume(queue: GuildIdResolvable): Queue;
158
226
  /**
159
227
  * Stop the guild stream
160
- * @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}
161
229
  * @returns {Promise<void>}
162
230
  * @throws {Error}
163
231
  * @example
@@ -171,10 +239,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
171
239
  * }
172
240
  * });
173
241
  */
174
- stop(queue: GuildIDResolvable): Promise<void>;
242
+ stop(queue: GuildIdResolvable): Promise<void>;
175
243
  /**
176
244
  * Set the guild stream's volume
177
- * @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}
178
246
  * @param {number} percent The percentage of volume you want to set
179
247
  * @returns {Queue} The guild queue
180
248
  * @throws {Error}
@@ -187,12 +255,12 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
187
255
  * distube.setVolume(message, Number(args[0]));
188
256
  * });
189
257
  */
190
- setVolume(queue: GuildIDResolvable, percent: number): Queue;
258
+ setVolume(queue: GuildIdResolvable, percent: number): Queue;
191
259
  /**
192
260
  * Skip the playing song if there is a next song in the queue.
193
261
  * <info>If {@link Queue#autoplay} is `true` and there is no up next song,
194
262
  * DisTube will add and play a related song.</info>
195
- * @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}
196
264
  * @returns {Promise<Song>} The new Song will be played
197
265
  * @throws {Error}
198
266
  * @example
@@ -204,10 +272,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
204
272
  * distube.skip(message);
205
273
  * });
206
274
  */
207
- skip(queue: GuildIDResolvable): Promise<Song>;
275
+ skip(queue: GuildIdResolvable): Promise<Song>;
208
276
  /**
209
277
  * Play the previous song
210
- * @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}
211
279
  * @returns {Promise<Song>} The new Song will be played
212
280
  * @throws {Error}
213
281
  * @example
@@ -219,10 +287,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
219
287
  * distube.previous(message);
220
288
  * });
221
289
  */
222
- previous(queue: GuildIDResolvable): Promise<Song>;
290
+ previous(queue: GuildIdResolvable): Promise<Song>;
223
291
  /**
224
292
  * Shuffle the guild queue songs
225
- * @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}
226
294
  * @returns {Promise<Queue>} The guild queue
227
295
  * @example
228
296
  * client.on('message', (message) => {
@@ -233,12 +301,12 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
233
301
  * distube.shuffle(message);
234
302
  * });
235
303
  */
236
- shuffle(queue: GuildIDResolvable): Promise<Queue>;
304
+ shuffle(queue: GuildIdResolvable): Promise<Queue>;
237
305
  /**
238
306
  * Jump to the song number in the queue.
239
307
  * The next one is 1, 2,...
240
308
  * The previous one is -1, -2,...
241
- * @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}
242
310
  * @param {number} num The song number to play
243
311
  * @returns {Promise<Queue>} The guild queue
244
312
  * @throws {Error} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
@@ -252,11 +320,11 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
252
320
  * .catch(err => message.channel.send("Invalid song number."));
253
321
  * });
254
322
  */
255
- jump(queue: GuildIDResolvable, num: number): Promise<Queue>;
323
+ jump(queue: GuildIdResolvable, num: number): Promise<Queue>;
256
324
  /**
257
325
  * Set the repeat mode of the guild queue.\
258
326
  * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
259
- * @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}
260
328
  * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
261
329
  * @returns {RepeatMode} The new repeat mode
262
330
  * @example
@@ -286,10 +354,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
286
354
  * }
287
355
  * message.channel.send("Set repeat mode to `" + mode + "`");
288
356
  */
289
- setRepeatMode(queue: GuildIDResolvable, mode?: number): number;
357
+ setRepeatMode(queue: GuildIdResolvable, mode?: number): number;
290
358
  /**
291
359
  * Toggle autoplay mode
292
- * @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}
293
361
  * @returns {boolean} Autoplay mode state
294
362
  * @throws {Error}
295
363
  * @example
@@ -303,17 +371,17 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
303
371
  * }
304
372
  * });
305
373
  */
306
- toggleAutoplay(queue: GuildIDResolvable): boolean;
374
+ toggleAutoplay(queue: GuildIdResolvable): boolean;
307
375
  /**
308
376
  * Add related song to the queue
309
- * @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}
310
378
  * @returns {Promise<Song>} The guild queue
311
379
  */
312
- addRelatedSong(queue: GuildIDResolvable): Promise<Song>;
380
+ addRelatedSong(queue: GuildIdResolvable): Promise<Song>;
313
381
  /**
314
382
  * Enable or disable filter(s) of the queue.
315
383
  * Available filters: {@link Filters}
316
- * @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}
317
385
  * @param {string|false} filter A filter name, `false` to clear all the filters
318
386
  * @param {boolean} [force=false] Force enable the input filter(s) even if it's enabled
319
387
  * @returns {Array<string>} Enabled filters.
@@ -328,10 +396,10 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
328
396
  * }
329
397
  * });
330
398
  */
331
- setFilter(queue: GuildIDResolvable, filter: string | false, force?: boolean): Array<string>;
399
+ setFilter(queue: GuildIdResolvable, filter: string | false, force?: boolean): Array<string>;
332
400
  /**
333
401
  * Set the playing time to another position
334
- * @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}
335
403
  * @param {number} time Time in seconds
336
404
  * @returns {Queue} Seeked queue
337
405
  * @example
@@ -343,14 +411,14 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
343
411
  * distube.seek(message, Number(args[0]));
344
412
  * });
345
413
  */
346
- seek(queue: GuildIDResolvable, time: number): Queue;
414
+ seek(queue: GuildIdResolvable, time: number): Queue;
347
415
  /**
348
416
  * Emit error event
349
417
  * @param {Error} error error
350
- * @param {Discord.TextChannel?} channel Text channel where the error is encountered.
418
+ * @param {Discord.BaseGuildTextChannel} [channel] Text channel where the error is encountered.
351
419
  * @private
352
420
  */
353
- emitError(error: Error, channel?: TextChannel): void;
421
+ emitError(error: Error, channel?: GuildTextBasedChannel): void;
354
422
  }
355
423
  export default DisTube;
356
424
  /**
@@ -390,7 +458,7 @@ export default DisTube;
390
458
  * Emitted when DisTube encounters an error.
391
459
  *
392
460
  * @event DisTube#error
393
- * @param {Discord.TextChannel} channel Text channel where the error is encountered.
461
+ * @param {Discord.BaseGuildTextChannel} channel Text channel where the error is encountered.
394
462
  * @param {Error} error The error encountered
395
463
  * @example
396
464
  * distube.on("error", (channel, error) => channel.send(
@@ -451,7 +519,7 @@ export default DisTube;
451
519
  */
452
520
  /**
453
521
  * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0,
454
- * and song param of {@link DisTube#playVoiceChannel} is invalid url.
522
+ * and song param of {@link DisTube#play} is invalid url.
455
523
  * DisTube will wait for user's next message to choose a song manually.
456
524
  * <info>{@link https://support.google.com/youtube/answer/7354993|Safe search} is enabled
457
525
  * if {@link DisTubeOptions}.nsfw is disabled and the message's channel is not a nsfw channel.</info>
@@ -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,EAOb,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AAExH;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;;;;;;;OAYG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAuDpD;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CACR,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAClD,OAAO,CAAC,IAAI,CAAC;IAoBhB;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CACpB,YAAY,EAAE,YAAY,GAAG,YAAY,EACzC,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,WAAW,CAAC;QAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;KACd,GACL,OAAO,CAAC,IAAI,CAAC;IAoEhB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,kBAAkB,CACtB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAC1C,UAAU,GAAE,GAAQ,EACpB,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO,GACtE,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;;;;;;;;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,WAAW,GAAG,IAAI;CAerD;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"}