Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Consolidate API types #9881

Merged
merged 4 commits into from
Oct 10, 2023
Merged

docs: Consolidate API types #9881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99d5da9
docs: deduplicate API types
Jiralite Oct 8, 2023
9aeaca3
Merge branch 'main' into docs/deduplicate-api-types
kodiakhq[bot] Oct 10, 2023
1dbaf7a
Merge branch 'main' into docs/deduplicate-api-types
kodiakhq[bot] Oct 10, 2023
fef890d
Merge branch 'main' into docs/deduplicate-api-types
kodiakhq[bot] Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions packages/discord.js/src/managers/ApplicationCommandPermissionsManager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 0 additions & 10 deletions packages/discord.js/src/structures/ApplicationCommand.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/AttachmentBuilder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 1 addition & 7 deletions packages/discord.js/src/structures/ClientPresence.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) {
Expand Down Expand Up @@ -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}
*/
6 changes: 0 additions & 6 deletions packages/discord.js/src/structures/CommandInteraction.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/Guild.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1373,8 +1373,3 @@ class Guild extends AnonymousGuild {
}

exports.Guild = Guild;

/**
* @external APIGuild
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object}
*/
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/GuildMember.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/MessagePayload.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/Role.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,3 @@ class Role extends Base {
}

exports.Role = Role;

/**
* @external APIRole
* @see {@link https://discord.com/developers/docs/topics/permissions#role-object}
*/
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/Sticker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,3 @@ class Sticker extends Base {
}

exports.Sticker = Sticker;

/**
* @external APISticker
* @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
*/
5 changes: 0 additions & 5 deletions packages/discord.js/src/structures/User.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
24 changes: 22 additions & 2 deletions packages/discord.js/src/util/APITypes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
*/

/**
Expand All @@ -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}
Expand Down Expand Up @@ -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}
Expand Down