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

docs: Correct tags used for objects (#6846)

Browse Source
This commit is contained in:
Jiralite
2021-10-16 23:17:33 +01:00
committed by GitHub
parent 267a4b3f68
commit f7b7aac8b6
4 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/managers/ApplicationCommandPermissionsManager.js
View File

@@ -71,9 +71,9 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* <warn>When passing these options to a manager where `guildId` is `null`,
* `guild` is a required parameter</warn>
* @typedef {Object} BaseApplicationCommandPermissionsOptions
* @param {GuildResolvable} [guild] The guild to modify / check permissions for
* @property {GuildResolvable} [guild] The guild to modify / check permissions for
* <warn>Ignored when the manager has a non-null `guildId` property</warn>
* @param {ApplicationCommandResolvable} [command] The command to modify / check permissions for
* @property {ApplicationCommandResolvable} [command] The command to modify / check permissions for
* <warn>Ignored when the manager has a non-null `commandId` property</warn>
*/
@@ -122,8 +122,8 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* <warn>One of `command` AND `permissions`, OR `fullPermissions` is required.
* `fullPermissions` is not a valid option when passing to a manager where `commandId` is non-null</warn>
* @typedef {BaseApplicationCommandPermissionsOptions} SetApplicationCommandPermissionsOptions
* @param {ApplicationCommandPermissionData[]} [permissions] The new permissions for the command
* @param {GuildApplicationCommandPermissionData[]} [fullPermissions] The new permissions for all commands
* @property {ApplicationCommandPermissionData[]} [permissions] The new permissions for the command
* @property {GuildApplicationCommandPermissionData[]} [fullPermissions] The new permissions for all commands
* in a guild <warn>When this parameter is set, `permissions` and `command` are ignored</warn>
*/
@@ -200,7 +200,7 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* Options used to add permissions to a command
* <warn>The `command` parameter is not optional when the managers `commandId` is `null`</warn>
* @typedef {BaseApplicationCommandPermissionsOptions} AddApplicationCommandPermissionsOptions
* @param {ApplicationCommandPermissionData[]} permissions The permissions to add to the command
* @property {ApplicationCommandPermissionData[]} permissions The permissions to add to the command
*/
/**
@@ -247,9 +247,9 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* Options used to remove permissions from a command
* <warn>The `command` parameter is not optional when the managers `commandId` is `null`</warn>
* @typedef {BaseApplicationCommandPermissionsOptions} RemoveApplicationCommandPermissionsOptions
* @param {UserResolvable|UserResolvable[]} [users] The user(s) to remove from the command permissions
* @property {UserResolvable|UserResolvable[]} [users] The user(s) to remove from the command permissions
* <warn>One of `users` or `roles` is required</warn>
* @param {RoleResolvable|RoleResolvable[]} [roles] The role(s) to remove from the command permissions
* @property {RoleResolvable|RoleResolvable[]} [roles] The role(s) to remove from the command permissions
* <warn>One of `users` or `roles` is required</warn>
*/
@@ -331,7 +331,7 @@ class ApplicationCommandPermissionsManager extends BaseManager {
* Options used to check the existence of permissions on a command
* <warn>The `command` parameter is not optional when the managers `commandId` is `null`</warn>
* @typedef {BaseApplicationCommandPermissionsOptions} HasApplicationCommandPermissionsOptions
* @param {UserResolvable|RoleResolvable} permissionId The user or role to check if a permission exists for
* @property {UserResolvable|RoleResolvable} permissionId The user or role to check if a permission exists for
* on this command.
*/

4
src/managers/GuildStickerManager.js
View File

@@ -34,8 +34,8 @@ class GuildStickerManager extends CachedManager {
/**
* Options for creating a guild sticker.
* @typedef {Object} GuildStickerCreateOptions
* @param {?string} [description] The description for the sticker
* @param {string} [reason] Reason for creating the sticker
* @property {?string} [description] The description for the sticker
* @property {string} [reason] Reason for creating the sticker
*/
/**

4
src/structures/GuildChannel.js
View File

@@ -393,8 +393,8 @@ class GuildChannel extends Channel {
/**
* Options used to set the position of a channel.
* @typedef {Object} SetChannelPositionOptions
* @param {boolean} [relative=false] Whether or not to change the position relative to its current value
* @param {string} [reason] The reason for changing the position
* @property {boolean} [relative=false] Whether or not to change the position relative to its current value
* @property {string} [reason] The reason for changing the position
*/
/**

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

@@ -101,8 +101,8 @@ class TextBasedChannel {
/**
* Options for sending a message with a reply.
* @typedef {Object} ReplyOptions
* @param {MessageResolvable} messageReference The message to reply to (must be in the same channel and not system)
* @param {boolean} [failIfNotExists=true] Whether to error if the referenced message
* @property {MessageResolvable} messageReference The message to reply to (must be in the same channel and not system)
* @property {boolean} [failIfNotExists=true] Whether to error if the referenced message
* does not exist (creates a standard message in this case when false)
*/