From 99d5da96fb1bbadd3672bff8a69d8bf99238a477 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Sun, 8 Oct 2023 13:37:48 +0100 Subject: [PATCH] docs: deduplicate API types --- .../ApplicationCommandPermissionsManager.js | 5 ---- .../src/structures/ApplicationCommand.js | 10 -------- .../src/structures/AttachmentBuilder.js | 5 ---- .../src/structures/ClientPresence.js | 8 +------ .../src/structures/CommandInteraction.js | 6 ----- packages/discord.js/src/structures/Guild.js | 5 ---- .../discord.js/src/structures/GuildMember.js | 5 ---- .../src/structures/MessagePayload.js | 5 ---- packages/discord.js/src/structures/Role.js | 5 ---- packages/discord.js/src/structures/Sticker.js | 5 ---- packages/discord.js/src/structures/User.js | 5 ---- packages/discord.js/src/util/APITypes.js | 24 +++++++++++++++++-- 12 files changed, 23 insertions(+), 65 deletions(-) diff --git a/packages/discord.js/src/managers/ApplicationCommandPermissionsManager.js b/packages/discord.js/src/managers/ApplicationCommandPermissionsManager.js index 2f7279ae3cf4..22049576bce8 100644 --- a/packages/discord.js/src/managers/ApplicationCommandPermissionsManager.js +++ b/packages/discord.js/src/managers/ApplicationCommandPermissionsManager.js @@ -423,11 +423,6 @@ class ApplicationCommandPermissionsManager extends BaseManager { module.exports = ApplicationCommandPermissionsManager; /* eslint-disable max-len */ -/** - * @external APIApplicationCommandPermissions - * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure} - */ - /** * Data that resolves to an id used for an application command permission * @typedef {UserResolvable|RoleResolvable|GuildChannelResolvable|RolePermissionConstant|ChannelPermissionConstant} ApplicationCommandPermissionIdResolvable diff --git a/packages/discord.js/src/structures/ApplicationCommand.js b/packages/discord.js/src/structures/ApplicationCommand.js index bd87281c11f5..09a1b75981cb 100644 --- a/packages/discord.js/src/structures/ApplicationCommand.js +++ b/packages/discord.js/src/structures/ApplicationCommand.js @@ -590,16 +590,6 @@ class ApplicationCommand extends Base { module.exports = ApplicationCommand; /* eslint-disable max-len */ -/** - * @external APIApplicationCommand - * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure} - */ - -/** - * @external APIApplicationCommandOption - * @see {@link https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure} - */ - /** * @external ApplicationCommandOptionAllowedChannelTypes * @see {@link https://discord.js.org/docs/packages/builders/stable/ApplicationCommandOptionAllowedChannelTypes:TypeAlias} diff --git a/packages/discord.js/src/structures/AttachmentBuilder.js b/packages/discord.js/src/structures/AttachmentBuilder.js index 6c638108d843..707234524871 100644 --- a/packages/discord.js/src/structures/AttachmentBuilder.js +++ b/packages/discord.js/src/structures/AttachmentBuilder.js @@ -104,11 +104,6 @@ class AttachmentBuilder { module.exports = AttachmentBuilder; -/** - * @external APIAttachment - * @see {@link https://discord.com/developers/docs/resources/channel#attachment-object} - */ - /** * @typedef {Object} AttachmentData * @property {string} [name] The name of the attachment diff --git a/packages/discord.js/src/structures/ClientPresence.js b/packages/discord.js/src/structures/ClientPresence.js index 6dd72ee94817..55d5fed012b8 100644 --- a/packages/discord.js/src/structures/ClientPresence.js +++ b/packages/discord.js/src/structures/ClientPresence.js @@ -36,7 +36,7 @@ class ClientPresence extends Presence { /** * Parses presence data into a packet ready to be sent to Discord * @param {PresenceData} presence The data to parse - * @returns {APIPresence} + * @returns {GatewayPresenceUpdateData} * @private */ _parse({ status, since, afk, activities }) { @@ -82,9 +82,3 @@ class ClientPresence extends Presence { } module.exports = ClientPresence; - -/* eslint-disable max-len */ -/** - * @external APIPresence - * @see {@link https://discord.com/developers/docs/rich-presence/how-to#updating-presence-update-presence-payload-fields} - */ diff --git a/packages/discord.js/src/structures/CommandInteraction.js b/packages/discord.js/src/structures/CommandInteraction.js index ec6ef404b0f5..f5cbb8337d9c 100644 --- a/packages/discord.js/src/structures/CommandInteraction.js +++ b/packages/discord.js/src/structures/CommandInteraction.js @@ -216,9 +216,3 @@ class CommandInteraction extends BaseInteraction { InteractionResponses.applyToClass(CommandInteraction, ['deferUpdate', 'update']); module.exports = CommandInteraction; - -/* eslint-disable max-len */ -/** - * @external APIInteractionDataResolved - * @see {@link https://discord.com/developers/docs/interactions/receiving-and-responding#interaction-object-resolved-data-structure} - */ diff --git a/packages/discord.js/src/structures/Guild.js b/packages/discord.js/src/structures/Guild.js index 329026e126c2..d2392af7fe3d 100644 --- a/packages/discord.js/src/structures/Guild.js +++ b/packages/discord.js/src/structures/Guild.js @@ -1371,8 +1371,3 @@ class Guild extends AnonymousGuild { } exports.Guild = Guild; - -/** - * @external APIGuild - * @see {@link https://discord.com/developers/docs/resources/guild#guild-object} - */ diff --git a/packages/discord.js/src/structures/GuildMember.js b/packages/discord.js/src/structures/GuildMember.js index db437920b39b..d813fb160b63 100644 --- a/packages/discord.js/src/structures/GuildMember.js +++ b/packages/discord.js/src/structures/GuildMember.js @@ -513,8 +513,3 @@ class GuildMember extends Base { TextBasedChannel.applyToClass(GuildMember); exports.GuildMember = GuildMember; - -/** - * @external APIGuildMember - * @see {@link https://discord.com/developers/docs/resources/guild#guild-member-object} - */ diff --git a/packages/discord.js/src/structures/MessagePayload.js b/packages/discord.js/src/structures/MessagePayload.js index e23730906c8e..f82b93bff2e8 100644 --- a/packages/discord.js/src/structures/MessagePayload.js +++ b/packages/discord.js/src/structures/MessagePayload.js @@ -288,11 +288,6 @@ module.exports = MessagePayload; * InteractionReplyOptions|InteractionUpdateOptions} MessagePayloadOption */ -/** - * @external APIMessage - * @see {@link https://discord.com/developers/docs/resources/channel#message-object} - */ - /** * @external RawFile * @see {@link https://discord.js.org/docs/packages/rest/stable/RawFile:Interface} diff --git a/packages/discord.js/src/structures/Role.js b/packages/discord.js/src/structures/Role.js index 53e413d889e0..698de2f7101c 100644 --- a/packages/discord.js/src/structures/Role.js +++ b/packages/discord.js/src/structures/Role.js @@ -464,8 +464,3 @@ class Role extends Base { } exports.Role = Role; - -/** - * @external APIRole - * @see {@link https://discord.com/developers/docs/topics/permissions#role-object} - */ diff --git a/packages/discord.js/src/structures/Sticker.js b/packages/discord.js/src/structures/Sticker.js index 4c7bb681a373..93075c5b6319 100644 --- a/packages/discord.js/src/structures/Sticker.js +++ b/packages/discord.js/src/structures/Sticker.js @@ -265,8 +265,3 @@ class Sticker extends Base { } exports.Sticker = Sticker; - -/** - * @external APISticker - * @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object} - */ diff --git a/packages/discord.js/src/structures/User.js b/packages/discord.js/src/structures/User.js index 4e38d2da4d42..3cf0c57f0459 100644 --- a/packages/discord.js/src/structures/User.js +++ b/packages/discord.js/src/structures/User.js @@ -373,8 +373,3 @@ class User extends Base { TextBasedChannel.applyToClass(User); module.exports = User; - -/** - * @external APIUser - * @see {@link https://discord.com/developers/docs/resources/user#user-object} - */ diff --git a/packages/discord.js/src/util/APITypes.js b/packages/discord.js/src/util/APITypes.js index 8f39c749b06b..700bd4b4c026 100644 --- a/packages/discord.js/src/util/APITypes.js +++ b/packages/discord.js/src/util/APITypes.js @@ -85,11 +85,21 @@ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIGuildForumTag} */ +/** + * @external APIGuildMember + * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIGuildMember} + */ + /** * @external APIInteraction * @see {@link https://discord-api-types.dev/api/discord-api-types-v10#APIInteraction} */ +/** + * @external APIInteractionDataResolved + * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIInteractionDataResolved} + */ + /** * @external APIInteractionDataResolvedChannel * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIInteractionDataResolvedChannel} @@ -151,8 +161,8 @@ */ /** - * @external APIPresence - * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIPresence} + * @external APIRole + * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIRole} */ /** @@ -165,6 +175,11 @@ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APISelectMenuOption} */ +/** + * @external APISticker + * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APISticker} + */ + /** * @external APIStringSelectComponent * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIStringSelectComponent} @@ -285,6 +300,11 @@ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/GatewayOpcodes} */ +/** + * @external GatewayPresenceUpdateData + * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/GatewayPresenceUpdateData} + */ + /** * @external GuildDefaultMessageNotifications * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/GuildDefaultMessageNotifications}