@kattowo/distube 6.0.0 → 6.0.2

package/README.md

@@ -88,14 +88,17 @@ DisTube ships no music source. Every source is a plugin, so a bot loads the ones
 
 ```javascript
 const { DisTube } = require("@kattowo/distube");
-const { YoutubePlugin } = require("@distube/youtube");
-const { SpotifyPlugin } = require("@distube/spotify");
+const { MyPlugin } = require("./my-plugin.js");
 
 const distube = new DisTube(client, {
-  plugins: [new YoutubePlugin(), new SpotifyPlugin()],
+  plugins: [new MyPlugin()],
 });
 ```
 
+This fork does not maintain the plugins of the upstream repository. They may not work with it, and
+they are not covered by the tests of this fork. Write your own extractor, or use a plugin that you
+trust and that you can keep up to date.
+
 A plugin that cannot hand out a static URL to FFmpeg registers a handler on the shared stream server
 of DisTube, so the bot runs one HTTP server instead of one per plugin.
 
@@ -103,7 +106,7 @@ of DisTube, so the bot runs one HTTP server instead of one per plugin.
 play options routes a query to a single source:
 
 ```javascript
-const result = await distube.search("never gonna give you up", { source: "youtube" });
+const result = await distube.search("never gonna give you up", { source: "my-source" });
 ```
 
 ## Documentation

package/dist/index.d.mts

@@ -321,7 +321,7 @@ interface SongInfo<T = unknown> {
      */
     plugin: DisTubePlugin | null;
     /**
-     * The identifier of the source of the song, e.g. `youtube`.
+     * The identifier of the source of the song, e.g. `my-source`.
      */
     source: string;
     /**
@@ -405,7 +405,7 @@ interface SongInfo<T = unknown> {
  */
 interface PlaylistInfo {
     /**
-     * The identifier of the source of the playlist, e.g. `youtube`.
+     * The identifier of the source of the playlist, e.g. `my-source`.
      */
     source: string;
     /**
@@ -2651,7 +2651,7 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @returns The DisTube instance
      * @example
      * ```ts
-     * const distube = await DisTube.create(client, { plugins: [new YoutubePlugin()] });
+     * const distube = await DisTube.create(client, { plugins: [new MyPlugin()] });
      * ```
      */
     static create(client: Client, opts?: DisTubeOptions): Promise<DisTube>;
@@ -2716,12 +2716,12 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      *
      * It matches the {@link Plugin.source} of the plugin, or one of its
      * {@link Plugin.aliases}. The identifier of the class is used when the
-     * plugin does not define a source (`YoutubePlugin` -> `youtube`).
+     * plugin does not define a source (`MyPlugin` -> `myplugin`).
      * @param source - The identifier of the source
      * @returns The plugin, or `undefined` when there is none
      * @example
      * ```ts
-     * const plugin = distube.getPlugin("youtube");
+     * const plugin = distube.getPlugin("myplugin");
      * ```
      */
     getPlugin(source: string): DisTubePlugin | undefined;
@@ -2844,7 +2844,7 @@ declare abstract class Plugin {
      * The identifier of the source of the plugin.
      *
      * It defaults to the name of the class, lowercased, without the `Plugin`
-     * suffix (`YoutubePlugin` -> `youtube`).
+     * suffix (`MyPlugin` -> `myplugin`).
      *
      * It is used to route a search to a plugin, and to find a plugin with
      * {@link DisTube#getPlugin}.
@@ -2983,7 +2983,7 @@ declare abstract class ExtractorPlugin extends Plugin {
     abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
     /**
      * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
+     * Not needed if the plugin plays the song itself.
      * @param song - Input song
      * @returns The url of the audio stream
      */
@@ -3056,7 +3056,7 @@ declare abstract class PlayableExtractorPlugin extends ExtractorPlugin {
     abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
     /**
      * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
+     * Not needed if the plugin plays the song itself.
      * @param song - Input song
      * @returns The url of the audio stream
      */

package/dist/index.d.ts

@@ -321,7 +321,7 @@ interface SongInfo<T = unknown> {
      */
     plugin: DisTubePlugin | null;
     /**
-     * The identifier of the source of the song, e.g. `youtube`.
+     * The identifier of the source of the song, e.g. `my-source`.
      */
     source: string;
     /**
@@ -405,7 +405,7 @@ interface SongInfo<T = unknown> {
  */
 interface PlaylistInfo {
     /**
-     * The identifier of the source of the playlist, e.g. `youtube`.
+     * The identifier of the source of the playlist, e.g. `my-source`.
      */
     source: string;
     /**
@@ -2651,7 +2651,7 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @returns The DisTube instance
      * @example
      * ```ts
-     * const distube = await DisTube.create(client, { plugins: [new YoutubePlugin()] });
+     * const distube = await DisTube.create(client, { plugins: [new MyPlugin()] });
      * ```
      */
     static create(client: Client, opts?: DisTubeOptions): Promise<DisTube>;
@@ -2716,12 +2716,12 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      *
      * It matches the {@link Plugin.source} of the plugin, or one of its
      * {@link Plugin.aliases}. The identifier of the class is used when the
-     * plugin does not define a source (`YoutubePlugin` -> `youtube`).
+     * plugin does not define a source (`MyPlugin` -> `myplugin`).
      * @param source - The identifier of the source
      * @returns The plugin, or `undefined` when there is none
      * @example
      * ```ts
-     * const plugin = distube.getPlugin("youtube");
+     * const plugin = distube.getPlugin("myplugin");
      * ```
      */
     getPlugin(source: string): DisTubePlugin | undefined;
@@ -2844,7 +2844,7 @@ declare abstract class Plugin {
      * The identifier of the source of the plugin.
      *
      * It defaults to the name of the class, lowercased, without the `Plugin`
-     * suffix (`YoutubePlugin` -> `youtube`).
+     * suffix (`MyPlugin` -> `myplugin`).
      *
      * It is used to route a search to a plugin, and to find a plugin with
      * {@link DisTube#getPlugin}.
@@ -2983,7 +2983,7 @@ declare abstract class ExtractorPlugin extends Plugin {
     abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
     /**
      * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
+     * Not needed if the plugin plays the song itself.
      * @param song - Input song
      * @returns The url of the audio stream
      */
@@ -3056,7 +3056,7 @@ declare abstract class PlayableExtractorPlugin extends ExtractorPlugin {
     abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
     /**
      * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
+     * Not needed if the plugin plays the song itself.
      * @param song - Input song
      * @returns The url of the audio stream
      */

package/dist/index.js

@@ -96,7 +96,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/constant.ts
-var version = "6.0.0";
+var version = "6.0.2";
 var AUDIO_SAMPLE_RATE = 48e3;
 var AUDIO_CHANNELS = 2;
 var DEFAULT_VOLUME = 50;
@@ -3409,7 +3409,7 @@ var DisTube = class _DisTube extends import_tiny_typed_emitter3.TypedEmitter {
    * @returns The DisTube instance
    * @example
    * ```ts
-   * const distube = await DisTube.create(client, { plugins: [new YoutubePlugin()] });
+   * const distube = await DisTube.create(client, { plugins: [new MyPlugin()] });
    * ```
    */
   static async create(client, opts = {}) {
@@ -3606,12 +3606,12 @@ ${e.message}`;
    *
    * It matches the {@link Plugin.source} of the plugin, or one of its
    * {@link Plugin.aliases}. The identifier of the class is used when the
-   * plugin does not define a source (`YoutubePlugin` -> `youtube`).
+   * plugin does not define a source (`MyPlugin` -> `myplugin`).
    * @param source - The identifier of the source
    * @returns The plugin, or `undefined` when there is none
    * @example
    * ```ts
-   * const plugin = distube.getPlugin("youtube");
+   * const plugin = distube.getPlugin("myplugin");
    * ```
    */
   getPlugin(source) {
@@ -3730,7 +3730,7 @@ var Plugin = class {
    * The identifier of the source of the plugin.
    *
    * It defaults to the name of the class, lowercased, without the `Plugin`
-   * suffix (`YoutubePlugin` -> `youtube`).
+   * suffix (`MyPlugin` -> `myplugin`).
    *
    * It is used to route a search to a plugin, and to find a plugin with
    * {@link DisTube#getPlugin}.