From 287981933eec19cc4c4599b4981a2d9c891bf05e Mon Sep 17 00:00:00 2001 From: DevAndromeda <46562212+DevAndromeda@users.noreply.github.com> Date: Tue, 19 Jul 2022 20:52:02 +0545 Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=EF=B8=8F=20Fix=20docgen?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/Player.ts | 2 +- src/Structures/Queue.ts | 4 ++-- src/VoiceInterface/StreamDispatcher.ts | 2 +- src/VoiceInterface/VoiceUtils.ts | 4 ++-- src/types/types.ts | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Player.ts b/src/Player.ts index 512685c..e1398a6 100644 --- a/src/Player.ts +++ b/src/Player.ts @@ -34,7 +34,7 @@ class Player extends EventEmitter { /** * 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(); diff --git a/src/Structures/Queue.ts b/src/Structures/Queue.ts index 94ad098..887471c 100644 --- a/src/Structures/Queue.ts +++ b/src/Structures/Queue.ts @@ -35,7 +35,7 @@ class Queue { * 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 { /** * 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} */ async play(src?: Track, options: PlayOptions = {}): Promise { diff --git a/src/VoiceInterface/StreamDispatcher.ts b/src/VoiceInterface/StreamDispatcher.ts index 96ce549..e8566fc 100644 --- a/src/VoiceInterface/StreamDispatcher.ts +++ b/src/VoiceInterface/StreamDispatcher.ts @@ -129,7 +129,7 @@ class StreamDispatcher extends EventEmitter { /** * 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 diff --git a/src/VoiceInterface/VoiceUtils.ts b/src/VoiceInterface/VoiceUtils.ts index f926c0a..99bf7ca 100644 --- a/src/VoiceInterface/VoiceUtils.ts +++ b/src/VoiceInterface/VoiceUtils.ts @@ -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} */ 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( diff --git a/src/types/types.ts b/src/types/types.ts index 4e345da..961da54 100644 --- a/src/types/types.ts +++ b/src/types/types.ts @@ -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 {