This commit is contained in:
Snowflake107 2021-04-21 17:53:24 +05:45
parent d94752da24
commit fa41ef65ec
2 changed files with 22 additions and 5 deletions

View file

@ -12,8 +12,8 @@
"build": "tsc",
"format": "prettier --write \"src/**/*.ts\"",
"lint": "tslint -p tsconfig.json",
"docs": "docgen --jsdoc jsdoc.json --source src/*.ts src/**/*.ts --custom docs/index.yml --output docs/docs.json",
"docs:test": "docgen --jsdoc jsdoc.json --source src/*.ts src/**/*.ts --custom docs/index.yml"
"docs": "docgen --jsdoc jsdoc.json --verbose --source src/*.ts src/**/*.ts --custom docs/index.yml --output docs/docs.json",
"docs:test": "docgen --jsdoc jsdoc.json --verbose --source src/*.ts src/**/*.ts --custom docs/index.yml"
},
"funding": "https://github.com/Androz2091/discord-player?sponsor=1",
"contributors": [

View file

@ -1335,7 +1335,11 @@ export default Player;
*/
/**
* @typedef {('soundcloud'|'youtube'|'arbitrary')} TrackSource
* The type of Track source, either:
* * `soundcloud` - a stream from SoundCloud
* * `youtube` - a stream from YouTube
* * `arbitrary` - arbitrary stream
* @typedef {String} TrackSource
*/
/**
@ -1359,7 +1363,20 @@ export default Player;
*/
/**
* @typedef {('soundcloud_track'|'soundcloud_playlist'|'spotify_song'|'spotify_album'|'spotify_playlist'|'youtube_video'|'youtube_playlist'|'vimeo'|'facebook'|'reverbnation'|'attachment'|'youtube_search')} QueryType The query type
* The query type, either:
* * `soundcloud_track` - a SoundCloud Track
* * `soundcloud_playlist` - a SoundCloud Playlist
* * `spotify_song` - a Spotify Song
* * `spotify_album` - a Spotify album
* * `spotify_playlist` - a Spotify playlist
* * `youtube_video` - a YouTube video
* * `youtube_playlist` - a YouTube playlist
* * `vimeo` - a Vimeo link
* * `facebook` - a Facebook link
* * `reverbnation` - a Reverbnation link
* * `attachment` - an attachment link
* * `youtube_search` - a YouTube search keyword
* @typedef {String} QueryType The query type
*/
/**
@ -1411,7 +1428,7 @@ export default Player;
* @property {String} [versions.v8] The v8 JavaScript engine version
* @property {Object} system The system data
* @property {String} [system.arch] The system arch
* @property {('aix'|'android'|'darwin'|'freebsd'|'linux'|'openbsd'|'sunos'|'win32'|'cygwin'|'netbsd')} [system.platform] The system platform
* @property {String} [system.platform] The system platform
* @property {Number} [system.cpu] The cpu count
* @property {Object} [system.memory] The memory info
* @property {String} [system.memory.total] The total memory