Skip to main content

Module: @sapphire/discord-utilities

Classes

Variables

ActionMetadataLimits

Const ActionMetadataLimits: Object

Namespace containing limits related to Discord Auto Moderation Action Metadata.

Type declaration

NameTypeDescription
MaximumCustomBlockMessageLength150Maximum number of characters allowed in a custom block message.
MaximumTimeoutDurationSeconds2419200Maximum timeout duration in seconds.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:676


AllowedMentionsLimits

Const AllowedMentionsLimits: Object

Namespace containing limits related to Discord Message Allowed Mentions.

Type declaration

NameTypeDescription
MaximumRoles100Maximum number of roles allowed in an allowed mentions object.
MaximumUsers100Maximum number of users allowed in an allowed mentions object.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:691


ApplicationCommandLimits

Const ApplicationCommandLimits: Object

Namespace containing limits related to Discord application commands (slash commands).

Type declaration

NameTypeDescription
MaximumCombinedCharacters4000Maximum combined characters allowed in the name, description, and value properties of an application command, its options (including subcommands and groups), and choices.
MaximumDescriptionCharacters100Maximum characters allowed in an application command description.
MaximumNameCharacters32Maximum characters allowed in an application command name.
MaximumOptionsLength25Maximum options allowed in an application command.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:236


ApplicationCommandOptionLimits

Const ApplicationCommandOptionLimits: Object

Namespace containing limits related to Choices of Discord Application Commands.

Type declaration

NameTypeDescription
MaximumChoicesLength25Maximum length of choices allowed in the option of an application command.
MaximumDescriptionCharacters100Maximum characters allowed in the description of an option of an application command.
MaximumNameCharacters32Maximum characters allowed in the name of an option of an application command.
MaximumStringLength6000Maximum length of string allowed in the string option of an application command.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:261


ApplicationCommandPermissionLimits

Const ApplicationCommandPermissionLimits: Object

Namespace containing limits related to Permissions of Discord Application Commands.

Type declaration

NameTypeDescription
MaximumPermissionsLength100Maximum length of permissions allowed in the option of an application command.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:286


ApplicationRoleConnectionLimits

Const ApplicationRoleConnectionLimits: Object

Namespace containing limits related to Discord Application Role Connections.

Type declaration

NameTypeDescription
MaximumMetadataRecords5Maximum application role connection metadata records an application can have.
MaximumMetadataValueLength100Maximum characters allowed in metadata values.
MaximumPlatformNameLength50Maximum characters allowed in a platform name.
MaximumPlatformUsernameLength100Maximum characters allowed in a platform username.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:546


AutoCompleteLimits

Const AutoCompleteLimits: Object

Namespace container limits related to Discord autocomplete interactions.

Type declaration

NameTypeDescription
MaximumAmountOfOptions25Maximum options allowed in a single autocomplete response.
MaximumLengthOfNameOfOption100Maximum characters allowed in a select menu option's name.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:486


AutoModerationRuleLimits

Const AutoModerationRuleLimits: Object

Namespace containing limits related to Discord Auto Moderation Rules.

Type declaration

NameTypeDescription
MaximumExemptChannels50Maximum number of exempt channels a rule can have.
MaximumExemptRoles20Maximum number of exempt roles a rule can have.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:586


ButtonLimits

Const ButtonLimits: Object

Namespace containing limits related to Message Buttons.

Type declaration

NameTypeDescription
MaximumCustomIdCharacters100Maximum characters allowed in a button custom ID.
MaximumLabelCharacters80Maximum characters allowed in a button label.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:296


ChannelInviteLimits

Const ChannelInviteLimits: Object

Namespace containing limits related to Discord Channel Invites.

Type declaration

NameTypeDescription
MaximumAgeSeconds604800Maximum age of an invite in seconds.
MaximumUses100Maximum number of uses allowed for an invite.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:706


ChannelLimits

Const ChannelLimits: Object

Namespace containing limits related to Discord channels.

Type declaration

NameTypeDescription
MaximumDescriptionLength1024Maximum characters allowed in a channel description.
MaximumNameLength100Maximum characters allowed in a channel name.
MaximumViewersPerScreenShare50Maximum viewers allowed per screen share. Deprecated Use VoiceChannelLimits.MaximumViewersPerScreenShare instead.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:4


ChannelMentionRegex

Const ChannelMentionRegex: RegExp

Regex that can capture the ID in Discord Channel mentions

Raw

/^<#(?<id>\d{17,20})>$/

Remark

Capture group 1 is the ID of the channel. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:6


ChannelMessageRegex

Const ChannelMessageRegex: RegExp

Regex that can capture the channel and message IDs in a channelId-messageId pattern This pattern can be found when you hold Shift and hover over a message, and click the "ID" button

Raw

/^(?<channelId>\d{17,20})-(?<messageId>\d{17,20})$/

Remark

Capture group 1 is the ID of the channel, named channelId.

Remark

Capture group 2 is the ID of the message, named messageId.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:15


DiscordHostnameRegex

Const DiscordHostnameRegex: RegExp

Regex that matches links on the known Discord host names

Raw

/(?<subdomain>\w+)\.?(?<hostname>dis(?:cord)?(?:app|merch|status)?)\.(?<tld>com|g(?:d|g|ift)|(?:de(?:sign|v))|media|new|store|net)/i

Remark

The regex is case insensitive

Remark

Capture group 1 is the subdomain for this URL. It is named subdomain.

Remark

Capture group 2 is the hostname for this URL, primarily discord but can also be discordmerch, discordstatus, dis, and discordapp. It is named hostname.

Remark

Capture group 3 is the Top-Level Domain without .. It is named tld.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:25


DiscordInviteLinkRegex

Const DiscordInviteLinkRegex: RegExp

Regex that can can capture the code of Discord invite links

Raw

/(?:^|\b)discord(?:(?:app)?\.com/invite|\.gg(?:/invite)?)/(?<code>[\w-]{2,255})(?:$|\b)/gi

Remark

Capture group 1 is the invite URL's unique code. It is named code.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:33


EmbedLimits

Const EmbedLimits: Object

Namespace containing limits related to Discord embeds.

Type declaration

NameTypeDescription
MaximumAuthorNameLength256Maximum characters allowed in the author field of an embed.
MaximumDescriptionLength4096Maximum characters allowed in an embed description.
MaximumFieldNameLength256Maximum characters allowed in the name of a field in an embed.
MaximumFieldValueLength1024Maximum characters allowed in the value of a field in an embed.
MaximumFields25Maximum fields allowed in an embed.
MaximumFooterLength2048Maximum characters allowed in a footer of an embed.
MaximumTitleLength256Maximum characters allowed in the title of an embed.
MaximumTotalCharacters6000Maximum characters allowed in an embed, in total.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:75


EmojiLimits

Const EmojiLimits: Object

Namespace containing limits related to Discord emojis.

Type declaration

NameTypeDescription
MaximumEmojiNameLength32Maximum characters allowed in a custom guild emoji.
MaximumEmojiSize256000Maximum size allowed for a custom guild emoji. Size is in bytes, and corresponds to 256KB.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:120


EmojiRegex

Const EmojiRegex: RegExp

Regex that can capture the ID of any animated or non-animated custom Discord emoji

Raw

/^(?:<(?<animated>a)?:(?<name>\w{2,32}):)?(?<id>\d{17,21})>?$/

Remark

Capture group 1 can be used to determine whether the emoji is animated or not. It is named animated.

Remark

Capture group 2 is the name of the emoji as it is typed in a message. It is named name.

Remark

Capture group 3 is the ID of the emoji. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:42


FormattedCustomEmoji

Const FormattedCustomEmoji: RegExp

Regex that matches any animated or non-animated custom Discord emoji. Unlike EmojiRegex It can be a substring of a larger string.

Raw

/<a?:\w{2,32}:\d{17,20}>/

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:49


FormattedCustomEmojiWithGroups

Const FormattedCustomEmojiWithGroups: RegExp

Regex that can capture any animated or non-animated custom Discord emoji. Similar to FormattedCustomEmoji and unlike EmojiRegex can also be a substring of a larger string.

Raw

/(?<animated>a?):(?<name>[^:]+):(?<id>\d{17,20})/

Remark

Capture group 1 can be used to determine whether the emoji is animated or not. It is named animated.

Remark

Capture group 2 is the name of the emoji as it is typed in a message. It is named name.

Remark

Capture group 3 is the ID of the emoji. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:59


GuildAuditLogsLimits

Const GuildAuditLogsLimits: Object

Namespace containing limits related to Discord Guild Audit Logs.

Type declaration

NameTypeDescription
MaximumEntriesToFetch100Maximum number of entries to return from the guild audit log API.
MinimumEntriesToFetch1Minimum number of entries to return from the guild audit log API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:571


GuildBansLimits

Const GuildBansLimits: Object

Namespace containing limits related to Discord guild bans.

Type declaration

NameTypeDescription
MaximumBansToFetch1000Maximum number of bans to return from the guild bans API.
MinimumBansToFetch1Minimum number of bans to return from the guild bans API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:196


GuildIntegrationLimits

Const GuildIntegrationLimits: Object

Namespace containing limits related to Discord Guild Integrations.

Type declaration

NameTypeDescription
MaximumIntegrationsToFetch50Maximum number of integrations returned from the guild integrations API. Needs a more description name than "MaximumIntegrations".

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:721


GuildLimits

Const GuildLimits: Object

Namespace containing limits related to Discord guilds.

Type declaration

NameTypeDescription
MaximumChannels500Maximum channels allowed per guild, including category channels.
MaximumRoles250Maximum roles allowed in a guild.
MaximumScheduledOrActiveEvents100Maximum scheduled or active events allowed in a guild.
MaximumUserGuildsToFetch200Maximum number of user guilds to return from the user guilds API.
MinimumUserGuildsToFetch1Minimum number of user guilds to return from the user guilds API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:136


GuildMemberLimits

Const GuildMemberLimits: Object

Namespace containing limits related to Discord guild members.

Type declaration

NameTypeDescription
MaximumDisplayNameLength32Maximum characters allowed in the display name of a guild member.
MaximumMembersToFetch1000Maximum number of members to return from the guild members API.
MinimumMembersToFetch1Minimum number of members to return from the guild members API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:176


GuildScheduledEventLimits

Const GuildScheduledEventLimits: Object

Namespace containing limits related to Discord guild scheduled events.

Type declaration

NameTypeDescription
MaximumUsersToFetch100Maximum number of users to return from the guild scheduled event users API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:166


HttpUrlRegex

Const HttpUrlRegex: RegExp

Regex that matches any URL starting with http or https

Raw

/^https?:///

Remark

for WebSocket URLs see WebSocketUrlRegex

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:66


InteractionLimits

Const InteractionLimits: Object

Namespace containing limits related to Discord interactions.

Type declaration

NameTypeDescription
MaximumButtonsPerActionRow5Maximum buttons allowed in a single action row.
MaximumOptionsInSelectMenus25Maximum options allowed in a single select menu.
MaximumSelectMenusPerActionRow1Maximum select menus allowed in a single action row.
MaximumTextInputsPerActionRow1Maximum text inputs allowed in a single action row.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:211


MessageLimits

Const MessageLimits: Object

Namespace containing limits related to Discord messages.

Type declaration

NameTypeDescription
MaximumActionRows5Maximum action rows allowed in a single message.
MaximumEmbeds10Maximum embeds allowed in a single message.
MaximumLength2000Maximum characters allowed in a single message for a user.
MaximumMessagesToBulkDelete100Maximum number of messages to delete in a single bulk delete request.
MaximumMessagesToFetch100Maximum number of messages to return from the channel messages API.
MaximumNitroBasicUploadSize50000000Maximum upload size for a Nitro Basic user, in any guild or in DMs. Size is in bytes, and corresponds to 50MB.
MaximumNitroLength4000Maximum characters allowed in a single message for a nitro user.
MaximumNitroUploadSize500000000Maximum upload size for a Nitro user, in any guild or in DMs. Size is in bytes, and corresponds to 500MB.
MaximumReactions20Maximum numbers of reactions allowed for a message.
MaximumRequestSize25000000Maximum request size when sending a messages. Size is in bytes, and corresponds to 25MB.
MaximumUploadSize25000000Maximum upload size for a free user in a guild of tier 1 or below, or in DMs. Size is in bytes, and corresponds to 25MB.
MaximumUploadSizeInGuildreadonly [25000000, 25000000, 50000000, 100000000]Maximum upload size for a free user for all different boost levels available in a guild. Sizes are in bytes, and correspond to 25MB, 25MB, 50MB, and 100MB.
MinimumMessagesToBulkDelete2Minimum number of messages to delete in a single bulk delete request.
MinimumMessagesToFetch1Minimum number of messages to return from the channel messages API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:356


MessageLinkRegex

Const MessageLinkRegex: RegExp

Regex that can capture the Guild, Channel, and Message ID based on a shareable Discord message link.

Raw

/^(?:https://)?(?:ptb\.|canary\.)?discord(?:app)?\.com/channels/(?<guildId>(?:\d{17,20}|@me))/(?<channelId>\d{17,20})/(?<messageId>\d{17,20})$/

Remark

Capture group 1 is the ID of the guild the message was sent in. It is named guildId.

Remark

Capture group 2 is the ID of the channel in that guild the message was sent in. It is named channelId.

Remark

Capture group 3 is the ID of the message itself. It is named messageId.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:75


ModalLimits

Const ModalLimits: Object

Namespace containing limits related to Discord Modals.

Type declaration

NameTypeDescription
MaximumComponents5Maximum components allowed in a modal.
MaximumCustomIdCharacters100Maximum characters allowed in a modal custom ID.
MaximumTitleCharacters45Maximum characters allowed in a modal title.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:501


ModerationLimits

Const ModerationLimits: Object

Namespace containing limits related to built-in moderation features.

Type declaration

NameTypeDescription
MaximumTimeoutDuration2419200Maximum duration of a guild timeout, in seconds (corresponds to 28 days).

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:451


ParsedCustomEmoji

Const ParsedCustomEmoji: RegExp

Regex that matches any animated or non-animated custom Discord emoji *without the wrapping <...> symbols. This means that a string that matches this regex can directly be send inside a Discord message. Other than this difference it is similar to FormattedCustomEmoji.

Raw

/a?:\w{2,32}:\d{17,20}/

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:84


ParsedCustomEmojiWithGroups

Const ParsedCustomEmojiWithGroups: RegExp

Regex that matches any animated or non-animated custom Discord emoji *without the wrapping <...> symbols. This means that a string that matches this regex can directly be send inside a Discord message. Other than this difference it is similar to FormattedCustomEmojiWithGroups.

Raw

/(?<animated>a?):(?<name>[^:]+):(?<id>\d{17,20})/

Remark

Capture group 1 can be used to determine whether the emoji is animated or not. It is named animated.

Remark

Capture group 2 is the name of the emoji as it is typed in a message. It is named name.

Remark

Capture group 3 is the ID of the emoji. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:95


ReactionLimits

Const ReactionLimits: Object

Namespace containing limits related to Discord message reactions.

Type declaration

NameTypeDescription
MaximumReactionsToFetchnumberMaximum number of reactions to fetch from the message reactions API.
MinimumReactionToFetchnumberMinimum number of reactions to fetch from the message reactions API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:436


RoleLimits

Const RoleLimits: Object

Namespace containing limits related to Discord roles.

Type declaration

NameTypeDescription
MaximumNameLength100Maximum characters allowed in a role name.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:461


RoleMentionRegex

Const RoleMentionRegex: RegExp

Regex that can capture the ID in Discord Role mentions

Raw

/^<@&(?<id>\d{17,20})>$/

Remark

Capture group 1 is the ID of the role. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:102


SelectMenuLimits

Const SelectMenuLimits: Object

Namespace containing limits related to Select Menus.

Type declaration

NameTypeDescription
MaximumCustomIdCharacters100Maximum characters allowed in a select menu custom ID.
MaximumLengthOfDescriptionOfOption100Maximum characters allowed in a select menu option's description.
MaximumLengthOfNameOfOption100Maximum characters allowed in a select menu option's name.
MaximumLengthOfValueOfOption100Maximum characters allowed in a select menu option's value.
MaximumMaxValuesSize25Maximum "maximum" values allowed in a select menu.
MaximumMinValuesSize25Maximum "minimum" values allowed in a select menu.
MaximumOptionsLength25Maximum amount of options allowed in a select menu.
MaximumPlaceholderCharacters150Maximum characters allowed in a select menu placeholder.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:311


SnowflakeRegex

Const SnowflakeRegex: RegExp

Regex that can capture any Discord Snowflake ID

Raw

/^(?<id>\d{17,20})$/

Remark

Capture group 1 is the Snowflake. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:109


StageChannelLimits

Const StageChannelLimits: Object

Namespace containing limits related to Discord stage channels.

Type declaration

NameTypeDescription
MaximumUserLimitnumberMaximum user limit of stage channel.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:40


StickerLimits

Const StickerLimits: Object

Namespace containing limits related to Discord Stickers.

Type declaration

NameTypeDescription
MaximumStickerSizenumberMaximum size allowed for a sticker. Size is in bytes, and corresponds to 512KB.
MaximumTagsLengthnumberMaximum number of characters allowed in the autocomplete/suggestion tags for the sticker.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:731


TextChannelLimits

Const TextChannelLimits: Object

Namespace containing limits related to Discord text channels.

Type declaration

NameTypeDescription
MaximumMessagePins50Maximum pins allowed in a text channel.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:50


TextInputLimits

Const TextInputLimits: Object

Namespace containing limits related to Discord Modal Text Input component.

Type declaration

NameTypeDescription
MaximumCustomIdCharacters100Maximum characters allowed in a text input custom ID.
MaximumLabelCharacters45Maximum characters allowed in a text input label.
MaximumPlaceholderCharacters100Maximum characters allowed in a text input placeholder.
MaximumValueCharacters4000Maximum characters allowed in a text input value.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:521


ThreadLimits

Const ThreadLimits: Object

Namespace containing limits related to Discord threads.

Type declaration

NameTypeDescription
MaximumThreadsToFetch100Maximum number of threads to return from the threads API.
MinimumThreadsToFetch1Minimum number of threads to return from the threads API.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:60


TokenRegex

Const TokenRegex: RegExp

Regex that can capture a Discord Token

Raw

/(?<mfaToken>mfa\.[a-z0-9_-]{20,})|(?<basicToken>[a-z0-9_-]{23,28}\.[a-z0-9_-]{6,7}\.[a-z0-9_-]{27})/i

Remark

Capture group 1 can be used to retrieve a token for a User that has Multi-Factor Authentication enabled. It is named mfaToken.

Remark

Capture group 2 can be used to retrieve a token for a User that doesn't have Multi-Factor Authentication enabled, or a Bot application. It is named basicToken.

Remark

For a valid token, either Capture group 1 or Capture group 2 will always be undefined, whereas the other group will then be defined and contain the matched token. You can use the name of the capture group to determine if the validated token was configured for a user with Multi-Factor Authentication, for a user without Multi-Factor Authentication, or for a bot application. If both capture groups are undefined, then the token is invalid.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:121


TriggerMetadataLimits

Const TriggerMetadataLimits: Object

Namespace containing limits related to Discord Auto Moderation Trigger Metadata.

Type declaration

NameTypeDescription
MaximumCharactersPerRegexPattern260Maximum number of characters allowed in a regular expression pattern.
MaximumKeywordAllowListKeywordLength60Maximum characters per keyword that should not trigger the keyword rule.
MaximumKeywordAllowListLength100Maximum number of substrings which should not trigger the keyword rule.
MaximumKeywordFilterLength60Maximum number of characters allowed in a keyword filter.
MaximumKeywordFilters1000Maximum number of substrings which will be searched for in content.
MaximumKeywordPresetAllowListKeywordPresetLength60Maximum characters per keyword should not trigger the keyword preset rule.
MaximumKeywordPresetAllowListLength1000Maximum number of substrings which should not trigger the keyword preset rule.
MaximumMentionSpamTotalMentions50Maximum number of unique role and user mentions allowed per message.
MaximumRegexPatterns10Maximum number of regular expression patterns which will be matched against content.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:626


TriggerTypeLimits

Const TriggerTypeLimits: Object

Namespace containing limits related to Discord Auto Moderation Triggers.

Type declaration

NameTypeDescription
MaximumKeywordPresetTriggersPerChannel1Maximum number of keyword triggers a channel can have.
MaximumKeywordTriggersPerGuild6Maximum number of keyword triggers a guild can have.
MaximumMentionSpamTriggersPerChannel1Maximum number of mention spam triggers a channel can have.
MaximumSpamTriggersPerGuild1Maximum number of mention spam triggers a guild can have.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:601


TwemojiRegex

Const TwemojiRegex: RegExp

Regex that can capture a Twemoji (Twitter Emoji)

Raw

See official source code

Defined in

projects/utilities/packages/discord-utilities/src/lib/TwemojiRegex.ts:5


UserLimits

Const UserLimits: Object

Namespace containing limits related to Discord users and Direct Messages.

Type declaration

NameTypeDescription
MaximumBiographyLength190Maximum characters allowed in a user's biography (the "About Me" section).
MaximumUsersPerDMGroup10Maximum numbers of users in a DM group.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:471


UserOrMemberMentionRegex

Const UserOrMemberMentionRegex: RegExp

Regex that can capture the ID of a user in Discord user mentions

Raw

/^<@!?(?<id>\d{17,20})>$/

Remark

Capture group 1 is the ID of the user. It is named id.

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:128


VoiceChannelLimits

Const VoiceChannelLimits: Object

Namespace containing limits related to Discord voice channels.

Type declaration

NameTypeDescription
MaximumUserLimitnumberMaximum user limit of voice channel.
MaximumViewersPerScreenSharenumberMaximum viewers allowed per screen share.

Defined in

projects/utilities/packages/discord-utilities/src/lib/limits.ts:25


WebSocketUrlRegex

Const WebSocketUrlRegex: RegExp

Regex that matches any WebSocket URL starting with ws or wss

Raw

/^wss?:///

Remark

for regular HTTP URLs see HttpUrlRegex

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:135


WebhookRegex

Const WebhookRegex: RegExp

Regex that captures the Webhook ID and token from a Discord Webhook URL.

Raw

/(?<url>^https://(?:(?:canary|ptb).)?discord(?:app)?.com/api(?:/v\d+)?/webhooks/(?<id>\d+)/(?<token>[\w-]+)/?$)/

Remark

Capture group 1 is the full URL of the Discord Webhook. It is named url.

Remark

Capture group 2 is the ID of the Discord Webhook. It is named id.

Remark

Capture group 3 is the token of the Discord Webhook. It is named token.

Remark

for regular HTTP URLs see HttpUrlRegex

Defined in

projects/utilities/packages/discord-utilities/src/lib/regexes.ts:145