Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-15 02:53:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Refactor a few @returns descriptions (#6228)

Browse Source
This commit is contained in:
Jiralite
2021-07-31 09:51:34 +01:00
committed by GitHub
parent 8b52d06ca9
commit 82daee576a
4 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/structures/GuildEmoji.js
View File

@@ -152,7 +152,7 @@ class GuildEmoji extends BaseGuildEmoji {
/** /**
* Whether this emoji is the same as another one. * Whether this emoji is the same as another one.
* @param {GuildEmoji|APIEmoji} other The emoji to compare it to * @param {GuildEmoji|APIEmoji} other The emoji to compare it to
* @returns {boolean} Whether the emoji is equal to the given emoji or not * @returns {boolean}
*/ */
equals(other) { equals(other) {
if (other instanceof GuildEmoji) { if (other instanceof GuildEmoji) {

2
src/structures/Sticker.js
View File

@@ -204,7 +204,7 @@ class Sticker extends Base {
/** /**
* Whether this sticker is the same as another one. * Whether this sticker is the same as another one.
* @param {Sticker|APISticker} other The sticker to compare it to * @param {Sticker|APISticker} other The sticker to compare it to
* @returns {boolean} Whether the sticker is equal to the given sticker or not * @returns {boolean}
*/ */
equals(other) { equals(other) {
if (other instanceof Sticker) { if (other instanceof Sticker) {

2
src/structures/TextChannel.js
View File

@@ -162,7 +162,7 @@ class TextChannel extends GuildChannel {
* Creates a webhook for the channel. * Creates a webhook for the channel.
* @param {string} name The name of the webhook * @param {string} name The name of the webhook
* @param {ChannelWebhookCreateOptions} [options] Options for creating the webhook * @param {ChannelWebhookCreateOptions} [options] Options for creating the webhook
* @returns {Promise<Webhook>} webhook The created webhook * @returns {Promise<Webhook>} Returns the created Webhook
* @example * @example
* // Create a webhook for the current channel * // Create a webhook for the current channel
* channel.createWebhook('Snek', { * channel.createWebhook('Snek', {

2
src/structures/interfaces/TextBasedChannel.js
View File

@@ -284,7 +284,7 @@ class TextBasedChannel {
* @param {Collection<Snowflake, Message>|MessageResolvable[]|number} messages * @param {Collection<Snowflake, Message>|MessageResolvable[]|number} messages
* Messages or number of messages to delete * Messages or number of messages to delete
* @param {boolean} [filterOld=false] Filter messages to remove those which are older than two weeks automatically * @param {boolean} [filterOld=false] Filter messages to remove those which are older than two weeks automatically
* @returns {Promise<Collection<Snowflake, Message>>} Deleted messages * @returns {Promise<Collection<Snowflake, Message>>} Returns the deleted messages
* @example * @example
* // Bulk delete messages * // Bulk delete messages
* channel.bulkDelete(5) * channel.bulkDelete(5)