docs: Consolidate API types (#9881)

docs: deduplicate API types Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
discordjs · Oct 10, 2023 · 44a3cbf · 44a3cbf
1 parent 332b624
commit 44a3cbf
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 65 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1373,8 +1373,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
@@ -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
@@ -290,11 +290,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
@@ -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
@@ -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
@@ -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
@@ -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}