🗒️ Fix docgen
This commit is contained in:
parent
f60c4bbf5d
commit
287981933e
5 changed files with 8 additions and 8 deletions
|
@ -34,7 +34,7 @@ class Player extends EventEmitter<PlayerEvents> {
|
|||
/**
|
||||
* Creates new Discord Player
|
||||
* @param {Client} client The Discord Client
|
||||
* @param {PlayerInitOptions} [options={}] The player init options
|
||||
* @param {PlayerInitOptions} [options] The player init options
|
||||
*/
|
||||
constructor(client: Client, options: PlayerInitOptions = {}) {
|
||||
super();
|
||||
|
|
|
@ -35,7 +35,7 @@ class Queue<T = unknown> {
|
|||
* Queue constructor
|
||||
* @param {Player} player The player that instantiated this queue
|
||||
* @param {Guild} guild The guild that instantiated this queue
|
||||
* @param {PlayerOptions} [options={}] Player options for the queue
|
||||
* @param {PlayerOptions} [options] Player options for the queue
|
||||
*/
|
||||
constructor(player: Player, guild: Guild, options: PlayerOptions = {}) {
|
||||
/**
|
||||
|
@ -621,7 +621,7 @@ class Queue<T = unknown> {
|
|||
/**
|
||||
* Play stream in a voice/stage channel
|
||||
* @param {Track} [src] The track to play (if empty, uses first track from the queue)
|
||||
* @param {PlayOptions} [options={}] The options
|
||||
* @param {PlayOptions} [options] The options
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
async play(src?: Track, options: PlayOptions = {}): Promise<void> {
|
||||
|
|
|
@ -129,7 +129,7 @@ class StreamDispatcher extends EventEmitter<VoiceEvents> {
|
|||
/**
|
||||
* Creates stream
|
||||
* @param {Readable|Duplex|string} src The stream source
|
||||
* @param {object} [ops={}] Options
|
||||
* @param {object} [ops] Options
|
||||
* @returns {AudioResource}
|
||||
*/
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
|
|
|
@ -20,7 +20,7 @@ class VoiceUtils {
|
|||
/**
|
||||
* Joins a voice channel, creating basic stream dispatch manager
|
||||
* @param {StageChannel|VoiceChannel} channel The voice channel
|
||||
* @param {object} [options={}] Join options
|
||||
* @param {object} [options] Join options
|
||||
* @returns {Promise<StreamDispatcher>}
|
||||
*/
|
||||
public async connect(
|
||||
|
@ -39,7 +39,7 @@ class VoiceUtils {
|
|||
/**
|
||||
* Joins a voice channel
|
||||
* @param {StageChannel|VoiceChannel} [channel] The voice/stage channel to join
|
||||
* @param {object} [options={}] Join options
|
||||
* @param {object} [options] Join options
|
||||
* @returns {VoiceConnection}
|
||||
*/
|
||||
public async join(
|
||||
|
|
|
@ -131,7 +131,7 @@ export interface PlayerProgressbarOptions {
|
|||
* @property {boolean} [leaveOnEmpty=true] If it should leave on empty
|
||||
* @property {number} [leaveOnEmptyCooldown=1000] The cooldown in ms
|
||||
* @property {boolean} [autoSelfDeaf=true] If it should set the bot in deaf mode
|
||||
* @property {YTDLDownloadOptions} [ytdlOptions={}] The youtube download options
|
||||
* @property {YTDLDownloadOptions} [ytdlOptions] The youtube download options
|
||||
* @property {number} [initialVolume=100] The initial player volume
|
||||
* @property {number} [bufferingTimeout=3000] Buffering timeout for the stream
|
||||
* @property {boolean} [spotifyBridge=true] If player should bridge spotify source to youtube
|
||||
|
@ -477,7 +477,7 @@ export interface PlaylistJSON {
|
|||
/**
|
||||
* @typedef {object} PlayerInitOptions
|
||||
* @property {boolean} [autoRegisterExtractor=true] If it should automatically register `@discord-player/extractor`
|
||||
* @property {YTDLDownloadOptions} [ytdlOptions={}] The options passed to `ytdl-core`
|
||||
* @property {YTDLDownloadOptions} [ytdlOptions] The options passed to `ytdl-core`
|
||||
* @property {number} [connectionTimeout=20000] The voice connection timeout
|
||||
*/
|
||||
export interface PlayerInitOptions {
|
||||
|
|
Loading…
Reference in a new issue