From 5239e5f9ccc64ad875a8c4c33ef23fd7f4b97d8f Mon Sep 17 00:00:00 2001 From: Snowflake107 Date: Sun, 13 Jun 2021 11:40:20 +0545 Subject: [PATCH] jsdoc --- src/Structures/ExtractorModel.ts | 16 ++++++++-------- src/Structures/Queue.ts | 2 +- src/Structures/Track.ts | 22 +++++++++++----------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/Structures/ExtractorModel.ts b/src/Structures/ExtractorModel.ts index dbbdae7..183747f 100644 --- a/src/Structures/ExtractorModel.ts +++ b/src/Structures/ExtractorModel.ts @@ -6,13 +6,13 @@ class ExtractorModel { /** * Model for raw Discord Player extractors - * @param {String} extractorName Name of the extractor - * @param {Object} data Extractor object + * @param {string} extractorName Name of the extractor + * @param {object} data Extractor object */ constructor(extractorName: string, data: any) { /** * The extractor name - * @type {String} + * @type {string} */ this.name = extractorName; @@ -21,7 +21,7 @@ class ExtractorModel { /** * Method to handle requests from `Player.play()` - * @param {String} query Query to handle + * @param {string} query Query to handle * @returns {Promise} */ async handle(query: string): Promise { @@ -42,8 +42,8 @@ class ExtractorModel { /** * Method used by Discord Player to validate query with this extractor - * @param {String} query The query to validate - * @returns {Boolean} + * @param {string} query The query to validate + * @returns {boolean} */ validate(query: string): boolean { return Boolean(this._raw.validate(query)); @@ -51,7 +51,7 @@ class ExtractorModel { /** * The extractor version - * @type {String} + * @type {string} */ get version(): string { return this._raw.version ?? "0.0.0"; @@ -59,7 +59,7 @@ class ExtractorModel { /** * If player should mark this extractor as important - * @type {Boolean} + * @type {boolean} */ get important(): boolean { return Boolean(this._raw.important); diff --git a/src/Structures/Queue.ts b/src/Structures/Queue.ts index 51823dd..2ae4f21 100644 --- a/src/Structures/Queue.ts +++ b/src/Structures/Queue.ts @@ -50,7 +50,7 @@ class Queue { const connection = await this.player.voiceUtils.connect(channel); this.connection = connection; - if (channel.type === "stage") await channel.guild.me.voice.setRequestToSpeak(true).catch((e) => {}); + if (channel.type === "stage") await channel.guild.me.voice.setRequestToSpeak(true).catch(() => {}); return this; } diff --git a/src/Structures/Track.ts b/src/Structures/Track.ts index e6c3183..7a5c5f6 100644 --- a/src/Structures/Track.ts +++ b/src/Structures/Track.ts @@ -33,43 +33,43 @@ class Track { /** * Title of this track * @name Track#title - * @type {String} + * @type {string} */ /** * Description of this track * @name Track#description - * @type {String} + * @type {string} */ /** * Author of this track * @name Track#author - * @type {String} + * @type {string} */ /** * URL of this track * @name Track#url - * @type {String} + * @type {string} */ /** * Thumbnail of this track * @name Track#thumbnail - * @type {String} + * @type {string} */ /** * Duration of this track * @name Track#duration - * @type {String} + * @type {string} */ /** * Views count of this track * @name Track#views - * @type {Number} + * @type {number} */ /** @@ -81,7 +81,7 @@ class Track { /** * If this track belongs to playlist * @name Track#fromPlaylist - * @type {Boolean} + * @type {boolean} */ /** @@ -117,7 +117,7 @@ class Track { /** * The track duration in millisecond - * @type {Number} + * @type {number} */ get durationMS(): number { const times = (n: number, t: number) => { @@ -143,7 +143,7 @@ class Track { /** * String representation of this track - * @returns {String} + * @returns {string} */ toString(): string { return `${this.title} by ${this.author}`; @@ -151,7 +151,7 @@ class Track { /** * Raw JSON representation of this track - * @returns {Object} + * @returns {object} */ toJSON() { return {