Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
skick1234 committed Jul 17, 2020
1 parent f9137dd commit f4400db
Show file tree
Hide file tree
Showing 3 changed files with 492 additions and 6 deletions.
12 changes: 7 additions & 5 deletions src/DisTube.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const ffmpegFilters = {
* Class representing a DisTube.
* @extends EventEmitter
*/
module.exports = class DisTube extends EventEmitter {
class DisTube extends EventEmitter {
/**
* Create new DisTube.
* @param {Discord.Client} client Discord.JS client
Expand Down Expand Up @@ -137,7 +137,7 @@ module.exports = class DisTube extends EventEmitter {
}

/**
* Skip the playing song and play a song or a playlist
* `@2.0.0` Skip the playing song and play a song or a playlist
* @async
* @param {Discord.Message} message The message from guild channel
* @param {(string|Song)} song `Youtube url`|`Search string`|`{@link DisTube#Song}`
Expand Down Expand Up @@ -215,7 +215,7 @@ module.exports = class DisTube extends EventEmitter {
}

/**
* Search for a song. You can customize how user answers instead of send a number
* `@2.0.0` Search for a song. You can customize how user answers instead of send a number
* (default of `{@link DisTube#play}()` search when `searchSongs` is `true`).
* Then use `{@link DisTube#play}(message, aResultToPlay)` or `{@link DisTube#playSkip}()` to play it.
* @async
Expand Down Expand Up @@ -639,12 +639,12 @@ module.exports = class DisTube extends EventEmitter {
}

/**
* Enable or disable a filter of the queue, replay playing song. Available filters: `3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`
* `@2.0.0` Enable or disable a filter of the queue, replay the playing song.
* Available filters: `3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`
*
* @param {Discord.Message} message The message from guild channel
* @param {string} filter A filter name
* @returns {string} Array of enabled filters.
*
* @example
* client.on('message', (message) => {
* const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
Expand Down Expand Up @@ -743,6 +743,8 @@ module.exports = class DisTube extends EventEmitter {
}
}

module.exports = DisTube;

/**
* Youtube playlist author
* @typedef {Object} ytpl_author
Expand Down
2 changes: 1 addition & 1 deletion src/Queue.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class Queue {
*/
this.autoplay = true;
/**
* Queue audio filter.
* `@v2.0.0` Queue audio filter.
* Available filters: `3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`
* @type {string}
*/
Expand Down
Loading

0 comments on commit f4400db

Please sign in to comment.