mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
docs: Refactor a few @returns descriptions (#6228)
This commit is contained in:
@@ -152,7 +152,7 @@ class GuildEmoji extends BaseGuildEmoji {
|
||||
/**
|
||||
* Whether this emoji is the same as another one.
|
||||
* @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) {
|
||||
if (other instanceof GuildEmoji) {
|
||||
|
||||
@@ -204,7 +204,7 @@ class Sticker extends Base {
|
||||
/**
|
||||
* Whether this sticker is the same as another one.
|
||||
* @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) {
|
||||
if (other instanceof Sticker) {
|
||||
|
||||
@@ -162,7 +162,7 @@ class TextChannel extends GuildChannel {
|
||||
* Creates a webhook for the channel.
|
||||
* @param {string} name The name of 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
|
||||
* // Create a webhook for the current channel
|
||||
* channel.createWebhook('Snek', {
|
||||
|
||||
@@ -284,7 +284,7 @@ class TextBasedChannel {
|
||||
* @param {Collection<Snowflake, Message>|MessageResolvable[]|number} messages
|
||||
* Messages or number of messages to delete
|
||||
* @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
|
||||
* // Bulk delete messages
|
||||
* channel.bulkDelete(5)
|
||||
|
||||
Reference in New Issue
Block a user