diff --git a/packages/discord.js/src/errors/ErrorCodes.js b/packages/discord.js/src/errors/ErrorCodes.js index 01071851d..2cf43a4a5 100644 --- a/packages/discord.js/src/errors/ErrorCodes.js +++ b/packages/discord.js/src/errors/ErrorCodes.js @@ -148,7 +148,7 @@ const { createEnum } = require('../util/Enums'); * @property {number} SweepFilterReturn */ -// JSDoc for intellisense purposes +// JSDoc for IntelliSense purposes /** * @type {DiscordjsErrorCodes} * @ignore diff --git a/packages/discord.js/src/util/Colors.js b/packages/discord.js/src/util/Colors.js index 5b4a38319..eb28057bc 100644 --- a/packages/discord.js/src/util/Colors.js +++ b/packages/discord.js/src/util/Colors.js @@ -1,5 +1,44 @@ 'use strict'; +/** + * @typedef {Object} Colors + * @property {number} Default + * @property {number} White + * @property {number} Aqua + * @property {number} Green + * @property {number} Blue + * @property {number} Yellow + * @property {number} Purple + * @property {number} LuminousVividPink + * @property {number} Fuchsia + * @property {number} Gold + * @property {number} Orange + * @property {number} Red + * @property {number} Grey + * @property {number} Navy + * @property {number} DarkAqua + * @property {number} DarkGreen + * @property {number} DarkBlue + * @property {number} DarkPurple + * @property {number} DarkVividPink + * @property {number} DarkGold + * @property {number} DarkOrange + * @property {number} DarkRed + * @property {number} DarkGrey + * @property {number} DarkerGrey + * @property {number} LightGrey + * @property {number} DarkNavy + * @property {number} Blurple + * @property {number} Greyple + * @property {number} DarkButNotBlack + * @property {number} NotQuiteBlack + */ + +// JSDoc for IntelliSense purposes +/** + * @type {Colors} + * @ignore + */ module.exports = { Default: 0x000000, White: 0xffffff, diff --git a/packages/discord.js/src/util/Events.js b/packages/discord.js/src/util/Events.js index 63db81d8c..38f81a0a8 100644 --- a/packages/discord.js/src/util/Events.js +++ b/packages/discord.js/src/util/Events.js @@ -1,5 +1,82 @@ 'use strict'; +/** + * @typedef {Object} Events + * @property {string} ApplicationCommandPermissionsUpdate applicationCommandPermissionsUpdate + * @property {string} CacheSweep cacheSweep + * @property {string} ChannelCreate channelCreate + * @property {string} ChannelDelete channelDelete + * @property {string} ChannelPinsUpdate channelPinsUpdate + * @property {string} ChannelUpdate channelUpdate + * @property {string} ClientReady ready + * @property {string} Debug debug + * @property {string} Error error + * @property {string} GuildBanAdd guildBanAdd + * @property {string} GuildBanRemove guildBanRemove + * @property {string} GuildCreate guildCreate + * @property {string} GuildDelete guildDelete + * @property {string} GuildEmojiCreate emojiCreate + * @property {string} GuildEmojiDelete emojiDelete + * @property {string} GuildEmojiUpdate emojiUpdate + * @property {string} GuildIntegrationsUpdate guildIntegrationsUpdate + * @property {string} GuildMemberAdd guildMemberAdd + * @property {string} GuildMemberAvailable guildMemberAvailable + * @property {string} GuildMemberRemove guildMemberRemove + * @property {string} GuildMembersChunk guildMembersChunk + * @property {string} GuildMemberUpdate guildMemberUpdate + * @property {string} GuildRoleCreate roleCreate + * @property {string} GuildRoleDelete roleDelete + * @property {string} GuildRoleUpdate roleUpdate + * @property {string} GuildScheduledEventCreate guildScheduledEventCreate + * @property {string} GuildScheduledEventDelete guildScheduledEventDelete + * @property {string} GuildScheduledEventUpdate guildScheduledEventUpdate + * @property {string} GuildScheduledEventUserAdd guildScheduledEventUserAdd + * @property {string} GuildScheduledEventUserRemove guildScheduledEventUserRemove + * @property {string} GuildStickerCreate stickerCreate + * @property {string} GuildStickerDelete stickerDelete + * @property {string} GuildStickerUpdate stickerUpdate + * @property {string} GuildUnavailable guildUnavailable + * @property {string} GuildUpdate guildUpdate + * @property {string} InteractionCreate interactionCreate + * @property {string} Invalidated invalidated + * @property {string} InviteCreate inviteCreate + * @property {string} InviteDelete inviteDelete + * @property {string} MessageBulkDelete messageDeleteBulk + * @property {string} MessageCreate messageCreate + * @property {string} MessageDelete messageDelete + * @property {string} MessageReactionAdd messageReactionAdd + * @property {string} MessageReactionRemove messageReactionRemove + * @property {string} MessageReactionRemoveAll messageReactionRemoveAll + * @property {string} MessageReactionRemoveEmoji messageReactionRemoveEmoji + * @property {string} MessageUpdate messageUpdate + * @property {string} PresenceUpdate presenceUpdate + * @property {string} ShardDisconnect shardDisconnect + * @property {string} ShardError shardError + * @property {string} ShardReady shardReady + * @property {string} ShardReconnecting shardReconnecting + * @property {string} ShardResume shardResume + * @property {string} StageInstanceCreate stageInstanceCreate + * @property {string} StageInstanceDelete stageInstanceDelete + * @property {string} StageInstanceUpdate stageInstanceUpdate + * @property {string} ThreadCreate threadCreate + * @property {string} ThreadDelete threadDelete + * @property {string} ThreadListSync threadListSync + * @property {string} ThreadMembersUpdate threadMembersUpdate + * @property {string} ThreadMemberUpdate threadMemberUpdate + * @property {string} ThreadUpdate threadUpdate + * @property {string} TypingStart typingStart + * @property {string} UserUpdate userUpdate + * @property {string} VoiceServerUpdate voiceServerUpdate + * @property {string} VoiceStateUpdate voiceStateUpdate + * @property {string} Warn warn + * @property {string} WebhooksUpdate webhookUpdate + */ + +// JSDoc for IntelliSense purposes +/** + * @type {Events} + * @ignore + */ module.exports = { ApplicationCommandPermissionsUpdate: 'applicationCommandPermissionsUpdate', CacheSweep: 'cacheSweep', diff --git a/packages/discord.js/src/util/Partials.js b/packages/discord.js/src/util/Partials.js index 0429b2327..3a73c9bee 100644 --- a/packages/discord.js/src/util/Partials.js +++ b/packages/discord.js/src/util/Partials.js @@ -2,6 +2,37 @@ const { createEnum } = require('./Enums'); +/** + * The enumeration for partials. + * ```js + * const { Client, Partials } = require('discord.js'); + * + * const client = new Client({ + * intents: [ + * // Intents... + * ], + * partials: [ + * Partials.User, // We want to receive uncached users! + * Partials.Message // We want to receive uncached messages! + * ] + * }); + * ``` + * @typedef {Object} Partials + * @property {number} User The partial to receive uncached users. + * @property {number} Channel The partial to receive uncached channels. + * This is required to receive direct messages! + * @property {number} GuildMember The partial to receive uncached guild members. + * @property {number} Message The partial to receive uncached messages. + * @property {number} Reaction The partial to receive uncached reactions. + * @property {number} GuildScheduledEvent The partial to receive uncached guild scheduled events. + * @property {number} ThreadMember The partial to receive uncached thread members. + */ + +// JSDoc for IntelliSense purposes +/** + * @type {Partials} + * @ignore + */ module.exports = createEnum([ 'User', 'Channel', diff --git a/packages/discord.js/src/util/ShardEvents.js b/packages/discord.js/src/util/ShardEvents.js index 102c722fd..5f9e3ad61 100644 --- a/packages/discord.js/src/util/ShardEvents.js +++ b/packages/discord.js/src/util/ShardEvents.js @@ -1,5 +1,20 @@ 'use strict'; +/** + * @typedef {Object} ShardEvents + * @property {string} Close close + * @property {string} Destroyed destroyed + * @property {string} InvalidSession invalidSession + * @property {string} Ready ready + * @property {string} Resumed resumed + * @property {string} AllReady allReady + */ + +// JSDoc for IntelliSense purposes +/** + * @type {ShardEvents} + * @ignore + */ module.exports = { Close: 'close', Destroyed: 'destroyed', diff --git a/packages/discord.js/src/util/Status.js b/packages/discord.js/src/util/Status.js index d614c72ac..e5241971c 100644 --- a/packages/discord.js/src/util/Status.js +++ b/packages/discord.js/src/util/Status.js @@ -2,6 +2,24 @@ const { createEnum } = require('./Enums'); +/** + * @typedef {Object} Status + * @property {number} Ready + * @property {number} Connecting + * @property {number} Reconnecting + * @property {number} Idle + * @property {number} Nearly + * @property {number} Disconnected + * @property {number} WaitingForGuilds + * @property {number} Identifying + * @property {number} Resuming + */ + +// JSDoc for IntelliSense purposes +/** + * @type {Status} + * @ignore + */ module.exports = createEnum([ 'Ready', 'Connecting',