From 520f471ac56cbc01402b79197333a8a34c4ac5c9 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Sat, 26 Mar 2022 12:55:53 +0000 Subject: [PATCH] docs: add back static properties and methods (#7706) --- .../src/structures/GuildAuditLogsEntry.js | 1 + .../src/structures/GuildTemplate.js | 1 + packages/discord.js/src/structures/Invite.js | 1 + .../src/structures/MessageMentions.js | 4 ++++ .../src/util/ActivityFlagsBitField.js | 1 + .../src/util/ApplicationFlagsBitField.js | 1 + packages/discord.js/src/util/BitField.js | 2 ++ packages/discord.js/src/util/Formatters.js | 19 +++++++++++++++++++ .../discord.js/src/util/IntentsBitField.js | 1 + .../src/util/MessageFlagsBitField.js | 1 + .../src/util/PermissionsBitField.js | 9 +++++++++ .../src/util/SystemChannelFlagsBitField.js | 1 + .../src/util/ThreadMemberFlagsBitField.js | 1 + 13 files changed, 43 insertions(+) diff --git a/packages/discord.js/src/structures/GuildAuditLogsEntry.js b/packages/discord.js/src/structures/GuildAuditLogsEntry.js index b6ead251685e..ac587219da41 100644 --- a/packages/discord.js/src/structures/GuildAuditLogsEntry.js +++ b/packages/discord.js/src/structures/GuildAuditLogsEntry.js @@ -66,6 +66,7 @@ class GuildAuditLogsEntry { /** * Key mirror of all available audit log targets. * @type {Object} + * @memberof GuildAuditLogsEntry */ static Targets = Targets; diff --git a/packages/discord.js/src/structures/GuildTemplate.js b/packages/discord.js/src/structures/GuildTemplate.js index 60a4dc9ad9e0..311014a60c7d 100644 --- a/packages/discord.js/src/structures/GuildTemplate.js +++ b/packages/discord.js/src/structures/GuildTemplate.js @@ -14,6 +14,7 @@ class GuildTemplate extends Base { /** * Regular expression that globally matches guild template links * @type {RegExp} + * @memberof GuildTemplate */ static GuildTemplatesPattern = /discord(?:app)?\.(?:com\/template|new)\/([\w-]{2,255})/gi; diff --git a/packages/discord.js/src/structures/Invite.js b/packages/discord.js/src/structures/Invite.js index f2a1c5f2de32..cf0f8de0d2f8 100644 --- a/packages/discord.js/src/structures/Invite.js +++ b/packages/discord.js/src/structures/Invite.js @@ -15,6 +15,7 @@ class Invite extends Base { /** * Regular expression that globally matches Discord invite links * @type {RegExp} + * @memberof Invite */ static InvitesPattern = /discord(?:(?:app)?\.com\/invite|\.gg(?:\/invite)?)\/([\w-]{2,255})/gi; diff --git a/packages/discord.js/src/structures/MessageMentions.js b/packages/discord.js/src/structures/MessageMentions.js index 77e1caed6a7b..25149b7d4541 100644 --- a/packages/discord.js/src/structures/MessageMentions.js +++ b/packages/discord.js/src/structures/MessageMentions.js @@ -10,24 +10,28 @@ class MessageMentions { /** * Regular expression that globally matches `@everyone` and `@here` * @type {RegExp} + * @memberof MessageMentions */ static EveryonePattern = /@(everyone|here)/g; /** * Regular expression that globally matches user mentions like `<@81440962496172032>` * @type {RegExp} + * @memberof MessageMentions */ static UsersPattern = /<@!?(\d{17,19})>/g; /** * Regular expression that globally matches role mentions like `<@&297577916114403338>` * @type {RegExp} + * @memberof MessageMentions */ static RolesPattern = /<@&(\d{17,19})>/g; /** * Regular expression that globally matches channel mentions like `<#222079895583457280>` * @type {RegExp} + * @memberof MessageMentions */ static ChannelsPattern = /<#(\d{17,19})>/g; diff --git a/packages/discord.js/src/util/ActivityFlagsBitField.js b/packages/discord.js/src/util/ActivityFlagsBitField.js index 23c37a247c1c..7c0ef76a2e73 100644 --- a/packages/discord.js/src/util/ActivityFlagsBitField.js +++ b/packages/discord.js/src/util/ActivityFlagsBitField.js @@ -11,6 +11,7 @@ class ActivityFlagsBitField extends BitField { /** * Numeric activity flags. * @type {ActivityFlags} + * @memberof ActivityFlagsBitField */ static Flags = ActivityFlags; } diff --git a/packages/discord.js/src/util/ApplicationFlagsBitField.js b/packages/discord.js/src/util/ApplicationFlagsBitField.js index ed867dfbae5c..6a5a9fe9fec1 100644 --- a/packages/discord.js/src/util/ApplicationFlagsBitField.js +++ b/packages/discord.js/src/util/ApplicationFlagsBitField.js @@ -11,6 +11,7 @@ class ApplicationFlagsBitField extends BitField { /** * Numeric application flags. All available properties: * @type {ApplicationFlags} + * @memberof ApplicationFlagsBitField */ static Flags = ApplicationFlags; } diff --git a/packages/discord.js/src/util/BitField.js b/packages/discord.js/src/util/BitField.js index 26dfba1e2459..02536fbe305e 100644 --- a/packages/discord.js/src/util/BitField.js +++ b/packages/discord.js/src/util/BitField.js @@ -10,12 +10,14 @@ class BitField { * Numeric bitfield flags. * Defined in extension classes * @type {Object} + * @memberof BitField * @abstract */ static Flags = {}; /** * @type {number|bigint} + * @memberof BitField * @private */ static DefaultBit = 0; diff --git a/packages/discord.js/src/util/Formatters.js b/packages/discord.js/src/util/Formatters.js index 5df19687aa31..b680ce10600e 100644 --- a/packages/discord.js/src/util/Formatters.js +++ b/packages/discord.js/src/util/Formatters.js @@ -28,6 +28,7 @@ class Formatters extends null { /** * Formats the content into a block quote. This needs to be at the start of the line for Discord to format it. * @method blockQuote + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -36,6 +37,7 @@ class Formatters extends null { /** * Formats the content into bold text. * @method bold + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -44,6 +46,7 @@ class Formatters extends null { /** * Formats a channel id into a channel mention. * @method channelMention + * @memberof Formatters * @param {string} channelId The channel id to format. * @returns {string} */ @@ -52,6 +55,7 @@ class Formatters extends null { /** * Wraps the content inside a code block with an optional language. * @method codeBlock + * @memberof Formatters * @param {string} contentOrLanguage The language to use, content if a second parameter isn't provided. * @param {string} [content] The content to wrap. * @returns {string} @@ -61,6 +65,8 @@ class Formatters extends null { /** * Formats an emoji id into a fully qualified emoji identifier * @method formatEmoji + * @memberof Formatters + * @memberof Formatters * @param {string} emojiId The emoji id to format. * @param {boolean} [animated] Whether the emoji is animated or not. Defaults to `false` * @returns {string} @@ -70,6 +76,7 @@ class Formatters extends null { /** * Wraps the URL into `<>`, which stops it from embedding. * @method hideLinkEmbed + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -78,6 +85,7 @@ class Formatters extends null { /** * Formats the content and the URL into a masked URL with an optional title. * @method hyperlink + * @memberof Formatters * @param {string} content The content to display. * @param {string} url The URL the content links to. * @param {string} [title] The title shown when hovering on the masked link. @@ -88,6 +96,7 @@ class Formatters extends null { /** * Wraps the content inside \`backticks\`, which formats it as inline code. * @method inlineCode + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -96,6 +105,7 @@ class Formatters extends null { /** * Formats the content into italic text. * @method italic + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -104,6 +114,7 @@ class Formatters extends null { /** * Formats a user id into a member-nickname mention. * @method memberNicknameMention + * @memberof Formatters * @param {string} memberId The user id to format. * @returns {string} */ @@ -112,6 +123,7 @@ class Formatters extends null { /** * Formats the content into a quote. This needs to be at the start of the line for Discord to format it. * @method quote + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -120,6 +132,7 @@ class Formatters extends null { /** * Formats a role id into a role mention. * @method roleMention + * @memberof Formatters * @param {string} roleId The role id to format. * @returns {string} */ @@ -128,6 +141,7 @@ class Formatters extends null { /** * Formats the content into spoiler text. * @method spoiler + * @memberof Formatters * @param {string} content The content to spoiler. * @returns {string} */ @@ -136,6 +150,7 @@ class Formatters extends null { /** * Formats the content into strike-through text. * @method strikethrough + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -144,6 +159,7 @@ class Formatters extends null { /** * Formats a date into a short date-time string. * @method time + * @memberof Formatters * @param {number|Date} [date] The date to format. * @param {TimestampStylesString} [style] The style to use. * @returns {string} @@ -167,12 +183,14 @@ class Formatters extends null { * The message formatting timestamp * [styles](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles) supported by Discord. * @type {Object} + * @memberof Formatters */ static TimestampStyles = TimestampStyles; /** * Formats the content into underscored text. * @method underscore + * @memberof Formatters * @param {string} content The content to wrap. * @returns {string} */ @@ -181,6 +199,7 @@ class Formatters extends null { /** * Formats a user id into a user mention. * @method userMention + * @memberof Formatters * @param {string} userId The user id to format. * @returns {string} */ diff --git a/packages/discord.js/src/util/IntentsBitField.js b/packages/discord.js/src/util/IntentsBitField.js index 1ad116324b6e..ea908b601757 100644 --- a/packages/discord.js/src/util/IntentsBitField.js +++ b/packages/discord.js/src/util/IntentsBitField.js @@ -10,6 +10,7 @@ class IntentsBitField extends BitField { /** * Numeric WebSocket intents * @type {GatewayIntentBits} + * @memberof IntentsBitField */ static Flags = GatewayIntentBits; } diff --git a/packages/discord.js/src/util/MessageFlagsBitField.js b/packages/discord.js/src/util/MessageFlagsBitField.js index 97d9dacf3115..71f1fd6c5c08 100644 --- a/packages/discord.js/src/util/MessageFlagsBitField.js +++ b/packages/discord.js/src/util/MessageFlagsBitField.js @@ -11,6 +11,7 @@ class MessageFlagsBitField extends BitField { /** * Numeric message flags. * @type {MessageFlags} + * @memberof MessageFlagsBitField */ static Flags = MessageFlags; } diff --git a/packages/discord.js/src/util/PermissionsBitField.js b/packages/discord.js/src/util/PermissionsBitField.js index 75d18f1688d3..78dd0a4d7be6 100644 --- a/packages/discord.js/src/util/PermissionsBitField.js +++ b/packages/discord.js/src/util/PermissionsBitField.js @@ -13,6 +13,7 @@ class PermissionsBitField extends BitField { /** * Numeric permission flags. * @type {PermissionFlagsBits} + * @memberof PermissionsBitField * @see {@link https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags} */ static Flags = PermissionFlagsBits; @@ -20,22 +21,30 @@ class PermissionsBitField extends BitField { /** * Bitfield representing every permission combined * @type {bigint} + * @memberof PermissionsBitField */ static All = Object.values(PermissionFlagsBits).reduce((all, p) => all | p, 0n); /** * Bitfield representing the default permissions for users * @type {bigint} + * @memberof PermissionsBitField */ static Default = BigInt(104324673); /** * Bitfield representing the permissions required for moderators of stage channels * @type {bigint} + * @memberof PermissionsBitField */ static StageModerator = PermissionFlagsBits.ManageChannels | PermissionFlagsBits.MuteMembers | PermissionFlagsBits.MoveMembers; + /** + * @type {bigint} + * @memberof PermissionsBitField + * @private + */ static DefaultBit = BigInt(0); /** diff --git a/packages/discord.js/src/util/SystemChannelFlagsBitField.js b/packages/discord.js/src/util/SystemChannelFlagsBitField.js index eead2639b1ce..cbca48f785a3 100644 --- a/packages/discord.js/src/util/SystemChannelFlagsBitField.js +++ b/packages/discord.js/src/util/SystemChannelFlagsBitField.js @@ -13,6 +13,7 @@ class SystemChannelFlagsBitField extends BitField { /** * Numeric system channel flags. * @type {GuildSystemChannelFlags} + * @memberof SystemChannelFlagsBitField */ static Flags = GuildSystemChannelFlags; } diff --git a/packages/discord.js/src/util/ThreadMemberFlagsBitField.js b/packages/discord.js/src/util/ThreadMemberFlagsBitField.js index 969db0c9b838..c5073a85f835 100644 --- a/packages/discord.js/src/util/ThreadMemberFlagsBitField.js +++ b/packages/discord.js/src/util/ThreadMemberFlagsBitField.js @@ -10,6 +10,7 @@ class ThreadMemberFlagsBitField extends BitField { /** * Numeric thread member flags. There are currently no bitflags relevant to bots for this. * @type {Object} + * @memberof ThreadMemberFlagsBitField */ static Flags = {}; }