docs: Description and missing @typedef fixes (#8087)

This commit is contained in:
Jiralite
2022-06-13 17:12:08 +01:00
committed by GitHub
parent 96053babe1
commit a2eebf6c66
2 changed files with 3 additions and 3 deletions

View File

@@ -27,7 +27,7 @@ class GuildEmojiManager extends BaseGuildEmojiManager {
/** /**
* Options used for creating an emoji in a guild. * Options used for creating an emoji in a guild.
* @typedef {Object} * @typedef {Object} GuildEmojiCreateOptions
* @property {BufferResolvable|Base64Resolvable} attachment The image for the emoji * @property {BufferResolvable|Base64Resolvable} attachment The image for the emoji
* @property {string} name The name for the emoji * @property {string} name The name for the emoji
* @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] The roles to limit the emoji to * @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] The roles to limit the emoji to

View File

@@ -33,7 +33,7 @@ class GuildStickerManager extends CachedManager {
} }
/** /**
* Options for creating a guild sticker. * Options used to create a guild sticker.
* @typedef {Object} GuildStickerCreateOptions * @typedef {Object} GuildStickerCreateOptions
* @property {BufferResolvable|Stream|JSONEncodable<AttachmentPayload>} file The file for the sticker * @property {BufferResolvable|Stream|JSONEncodable<AttachmentPayload>} file The file for the sticker
* @property {string} name The name for the sticker * @property {string} name The name for the sticker
@@ -44,7 +44,7 @@ class GuildStickerManager extends CachedManager {
/** /**
* Creates a new custom sticker in the guild. * Creates a new custom sticker in the guild.
* @param {GuildStickerCreateOptions} options Options * @param {GuildStickerCreateOptions} options Options for creating a guild sticker
* @returns {Promise<Sticker>} The created sticker * @returns {Promise<Sticker>} The created sticker
* @example * @example
* // Create a new sticker from a URL * // Create a new sticker from a URL