@discordjs/formatters 0.3.3-dev.1692922197-22011575c.0 → 0.3.4-dev.1699834164-2d63d9355

package/README.md

@@ -29,6 +29,7 @@
 npm install @discordjs/formatters
 yarn add @discordjs/formatters
 pnpm add @discordjs/formatters
+bun add @discordjs/formatters
 ```
 
 ## Example usage

package/dist/index.d.mts

@@ -173,77 +173,77 @@ declare function escapeMaskedLink(text: string): string;
 /**
  * Wraps the content inside a code block with no language.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function codeBlock<C extends string>(content: C): `\`\`\`\n${C}\n\`\`\``;
+declare function codeBlock<Content extends string>(content: Content): `\`\`\`\n${Content}\n\`\`\``;
 /**
  * Wraps the content inside a code block with the specified language.
  *
- * @typeParam L - This is inferred by the supplied language
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Language - This is inferred by the supplied language
+ * @typeParam Content - This is inferred by the supplied content
  * @param language - The language for the code block
  * @param content - The content to wrap
  */
-declare function codeBlock<L extends string, C extends string>(language: L, content: C): `\`\`\`${L}\n${C}\n\`\`\``;
+declare function codeBlock<Language extends string, Content extends string>(language: Language, content: Content): `\`\`\`${Language}\n${Content}\n\`\`\``;
 /**
  * Wraps the content inside \`backticks\` which formats it as inline code.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function inlineCode<C extends string>(content: C): `\`${C}\``;
+declare function inlineCode<Content extends string>(content: Content): `\`${Content}\``;
 /**
  * Formats the content into italic text.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function italic<C extends string>(content: C): `_${C}_`;
+declare function italic<Content extends string>(content: Content): `_${Content}_`;
 /**
  * Formats the content into bold text.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function bold<C extends string>(content: C): `**${C}**`;
+declare function bold<Content extends string>(content: Content): `**${Content}**`;
 /**
  * Formats the content into underscored text.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function underscore<C extends string>(content: C): `__${C}__`;
+declare function underscore<Content extends string>(content: Content): `__${Content}__`;
 /**
  * Formats the content into strike-through text.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function strikethrough<C extends string>(content: C): `~~${C}~~`;
+declare function strikethrough<Content extends string>(content: Content): `~~${Content}~~`;
 /**
  * Formats the content into a quote.
  *
  * @remarks This needs to be at the start of the line for Discord to format it.
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function quote<C extends string>(content: C): `> ${C}`;
+declare function quote<Content extends string>(content: Content): `> ${Content}`;
 /**
  * Formats the content into a block quote.
  *
  * @remarks This needs to be at the start of the line for Discord to format it.
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function blockQuote<C extends string>(content: C): `>>> ${C}`;
+declare function blockQuote<Content extends string>(content: Content): `>>> ${Content}`;
 /**
  * Wraps the URL into `<>` which stops it from embedding.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param url - The URL to wrap
  */
-declare function hideLinkEmbed<C extends string>(url: C): `<${C}>`;
+declare function hideLinkEmbed<Content extends string>(url: Content): `<${Content}>`;
 /**
  * Wraps the URL into `<>` which stops it from embedding.
  *
@@ -253,161 +253,219 @@ declare function hideLinkEmbed(url: URL): `<${string}>`;
 /**
  * Formats the content and the URL into a masked URL.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to display
  * @param url - The URL the content links to
  */
-declare function hyperlink<C extends string>(content: C, url: URL): `[${C}](${string})`;
+declare function hyperlink<Content extends string>(content: Content, url: URL): `[${Content}](${string})`;
 /**
  * Formats the content and the URL into a masked URL.
  *
- * @typeParam C - This is inferred by the supplied content
- * @typeParam U - This is inferred by the supplied URL
+ * @typeParam Content - This is inferred by the supplied content
+ * @typeParam Url - This is inferred by the supplied URL
  * @param content - The content to display
  * @param url - The URL the content links to
  */
-declare function hyperlink<C extends string, U extends string>(content: C, url: U): `[${C}](${U})`;
+declare function hyperlink<Content extends string, Url extends string>(content: Content, url: Url): `[${Content}](${Url})`;
 /**
  * Formats the content and the URL into a masked URL with a custom tooltip.
  *
- * @typeParam C - This is inferred by the supplied content
- * @typeParam T - This is inferred by the supplied title
+ * @typeParam Content - This is inferred by the supplied content
+ * @typeParam Title - This is inferred by the supplied title
  * @param content - The content to display
  * @param url - The URL the content links to
  * @param title - The title shown when hovering on the masked link
  */
-declare function hyperlink<C extends string, T extends string>(content: C, url: URL, title: T): `[${C}](${string} "${T}")`;
+declare function hyperlink<Content extends string, Title extends string>(content: Content, url: URL, title: Title): `[${Content}](${string} "${Title}")`;
 /**
  * Formats the content and the URL into a masked URL with a custom tooltip.
  *
- * @typeParam C - This is inferred by the supplied content
- * @typeParam U - This is inferred by the supplied URL
- * @typeParam T - This is inferred by the supplied title
+ * @typeParam Content - This is inferred by the supplied content
+ * @typeParam Url - This is inferred by the supplied URL
+ * @typeParam Title - This is inferred by the supplied title
  * @param content - The content to display
  * @param url - The URL the content links to
  * @param title - The title shown when hovering on the masked link
  */
-declare function hyperlink<C extends string, U extends string, T extends string>(content: C, url: U, title: T): `[${C}](${U} "${T}")`;
+declare function hyperlink<Content extends string, Url extends string, Title extends string>(content: Content, url: Url, title: Title): `[${Content}](${Url} "${Title}")`;
 /**
  * Formats the content into a spoiler.
  *
- * @typeParam C - This is inferred by the supplied content
+ * @typeParam Content - This is inferred by the supplied content
  * @param content - The content to wrap
  */
-declare function spoiler<C extends string>(content: C): `||${C}||`;
+declare function spoiler<Content extends string>(content: Content): `||${Content}||`;
 /**
  * Formats a user id into a user mention.
  *
- * @typeParam C - This is inferred by the supplied user id
+ * @typeParam UserId - This is inferred by the supplied user id
  * @param userId - The user id to format
  */
-declare function userMention<C extends Snowflake>(userId: C): `<@${C}>`;
+declare function userMention<UserId extends Snowflake>(userId: UserId): `<@${UserId}>`;
 /**
  * Formats a channel id into a channel mention.
  *
- * @typeParam C - This is inferred by the supplied channel id
+ * @typeParam ChannelId - This is inferred by the supplied channel id
  * @param channelId - The channel id to format
  */
-declare function channelMention<C extends Snowflake>(channelId: C): `<#${C}>`;
+declare function channelMention<ChannelId extends Snowflake>(channelId: ChannelId): `<#${ChannelId}>`;
 /**
  * Formats a role id into a role mention.
  *
- * @typeParam C - This is inferred by the supplied role id
+ * @typeParam RoleId - This is inferred by the supplied role id
  * @param roleId - The role id to format
  */
-declare function roleMention<C extends Snowflake>(roleId: C): `<@&${C}>`;
+declare function roleMention<RoleId extends Snowflake>(roleId: RoleId): `<@&${RoleId}>`;
 /**
  * Formats an application command name, subcommand group name, subcommand name, and id into an application command mention.
  *
- * @typeParam N - This is inferred by the supplied command name
- * @typeParam G - This is inferred by the supplied subcommand group name
- * @typeParam S - This is inferred by the supplied subcommand name
- * @typeParam I - This is inferred by the supplied command id
+ * @typeParam CommandName - This is inferred by the supplied command name
+ * @typeParam SubcommandGroupName - This is inferred by the supplied subcommand group name
+ * @typeParam SubcommandName - This is inferred by the supplied subcommand name
+ * @typeParam CommandId - This is inferred by the supplied command id
  * @param commandName - The application command name to format
  * @param subcommandGroupName - The subcommand group name to format
  * @param subcommandName - The subcommand name to format
  * @param commandId - The application command id to format
  */
-declare function chatInputApplicationCommandMention<N extends string, G extends string, S extends string, I extends Snowflake>(commandName: N, subcommandGroupName: G, subcommandName: S, commandId: I): `</${N} ${G} ${S}:${I}>`;
+declare function chatInputApplicationCommandMention<CommandName extends string, SubcommandGroupName extends string, SubcommandName extends string, CommandId extends Snowflake>(commandName: CommandName, subcommandGroupName: SubcommandGroupName, subcommandName: SubcommandName, commandId: CommandId): `</${CommandName} ${SubcommandGroupName} ${SubcommandName}:${CommandId}>`;
 /**
  * Formats an application command name, subcommand name, and id into an application command mention.
  *
- * @typeParam N - This is inferred by the supplied command name
- * @typeParam S - This is inferred by the supplied subcommand name
- * @typeParam I - This is inferred by the supplied command id
+ * @typeParam CommandName - This is inferred by the supplied command name
+ * @typeParam SubcommandName - This is inferred by the supplied subcommand name
+ * @typeParam CommandId - This is inferred by the supplied command id
  * @param commandName - The application command name to format
  * @param subcommandName - The subcommand name to format
  * @param commandId - The application command id to format
  */
-declare function chatInputApplicationCommandMention<N extends string, S extends string, I extends Snowflake>(commandName: N, subcommandName: S, commandId: I): `</${N} ${S}:${I}>`;
+declare function chatInputApplicationCommandMention<CommandName extends string, SubcommandName extends string, CommandId extends Snowflake>(commandName: CommandName, subcommandName: SubcommandName, commandId: CommandId): `</${CommandName} ${SubcommandName}:${CommandId}>`;
 /**
  * Formats an application command name and id into an application command mention.
  *
- * @typeParam N - This is inferred by the supplied command name
- * @typeParam I - This is inferred by the supplied command id
+ * @typeParam CommandName - This is inferred by the supplied command name
+ * @typeParam CommandId - This is inferred by the supplied command id
  * @param commandName - The application command name to format
  * @param commandId - The application command id to format
  */
-declare function chatInputApplicationCommandMention<N extends string, I extends Snowflake>(commandName: N, commandId: I): `</${N}:${I}>`;
+declare function chatInputApplicationCommandMention<CommandName extends string, CommandId extends Snowflake>(commandName: CommandName, commandId: CommandId): `</${CommandName}:${CommandId}>`;
 /**
  * Formats a non-animated emoji id into a fully qualified emoji identifier.
  *
- * @typeParam C - This is inferred by the supplied emoji id
+ * @typeParam EmojiId - This is inferred by the supplied emoji id
  * @param emojiId - The emoji id to format
  */
-declare function formatEmoji<C extends Snowflake>(emojiId: C, animated?: false): `<:_:${C}>`;
+declare function formatEmoji<EmojiId extends Snowflake>(emojiId: EmojiId, animated?: false): `<:_:${EmojiId}>`;
 /**
  * Formats an animated emoji id into a fully qualified emoji identifier.
  *
- * @typeParam C - This is inferred by the supplied emoji id
+ * @typeParam EmojiId - This is inferred by the supplied emoji id
  * @param emojiId - The emoji id to format
  * @param animated - Whether the emoji is animated
  */
-declare function formatEmoji<C extends Snowflake>(emojiId: C, animated?: true): `<a:_:${C}>`;
+declare function formatEmoji<EmojiId extends Snowflake>(emojiId: EmojiId, animated?: true): `<a:_:${EmojiId}>`;
 /**
  * Formats an emoji id into a fully qualified emoji identifier.
  *
- * @typeParam C - This is inferred by the supplied emoji id
+ * @typeParam EmojiId - This is inferred by the supplied emoji id
  * @param emojiId - The emoji id to format
  * @param animated - Whether the emoji is animated
  */
-declare function formatEmoji<C extends Snowflake>(emojiId: C, animated?: boolean): `<:_:${C}>` | `<a:_:${C}>`;
+declare function formatEmoji<EmojiId extends Snowflake>(emojiId: EmojiId, animated?: boolean): `<:_:${EmojiId}>` | `<a:_:${EmojiId}>`;
 /**
  * Formats a channel link for a direct message channel.
  *
- * @typeParam C - This is inferred by the supplied channel id
+ * @typeParam ChannelId - This is inferred by the supplied channel id
  * @param channelId - The channel's id
  */
-declare function channelLink<C extends Snowflake>(channelId: C): `https://discord.com/channels/@me/${C}`;
+declare function channelLink<ChannelId extends Snowflake>(channelId: ChannelId): `https://discord.com/channels/@me/${ChannelId}`;
 /**
  * Formats a channel link for a guild channel.
  *
- * @typeParam C - This is inferred by the supplied channel id
- * @typeParam G - This is inferred by the supplied guild id
+ * @typeParam ChannelId - This is inferred by the supplied channel id
+ * @typeParam GuildId - This is inferred by the supplied guild id
  * @param channelId - The channel's id
  * @param guildId - The guild's id
  */
-declare function channelLink<C extends Snowflake, G extends Snowflake>(channelId: C, guildId: G): `https://discord.com/channels/${G}/${C}`;
+declare function channelLink<ChannelId extends Snowflake, GuildId extends Snowflake>(channelId: ChannelId, guildId: GuildId): `https://discord.com/channels/${GuildId}/${ChannelId}`;
 /**
  * Formats a message link for a direct message channel.
  *
- * @typeParam C - This is inferred by the supplied channel id
- * @typeParam M - This is inferred by the supplied message id
+ * @typeParam ChannelId - This is inferred by the supplied channel id
+ * @typeParam MessageId - This is inferred by the supplied message id
  * @param channelId - The channel's id
  * @param messageId - The message's id
  */
-declare function messageLink<C extends Snowflake, M extends Snowflake>(channelId: C, messageId: M): `https://discord.com/channels/@me/${C}/${M}`;
+declare function messageLink<ChannelId extends Snowflake, MessageId extends Snowflake>(channelId: ChannelId, messageId: MessageId): `https://discord.com/channels/@me/${ChannelId}/${MessageId}`;
 /**
  * Formats a message link for a guild channel.
  *
- * @typeParam C - This is inferred by the supplied channel id
- * @typeParam M - This is inferred by the supplied message id
- * @typeParam G - This is inferred by the supplied guild id
+ * @typeParam ChannelId - This is inferred by the supplied channel id
+ * @typeParam MessageId - This is inferred by the supplied message id
+ * @typeParam GuildId - This is inferred by the supplied guild id
  * @param channelId - The channel's id
  * @param messageId - The message's id
  * @param guildId - The guild's id
  */
-declare function messageLink<C extends Snowflake, M extends Snowflake, G extends Snowflake>(channelId: C, messageId: M, guildId: G): `https://discord.com/channels/${G}/${C}/${M}`;
+declare function messageLink<ChannelId extends Snowflake, MessageId extends Snowflake, GuildId extends Snowflake>(channelId: ChannelId, messageId: MessageId, guildId: GuildId): `https://discord.com/channels/${GuildId}/${ChannelId}/${MessageId}`;
+/**
+ * The heading levels for expanded markdown.
+ */
+declare enum HeadingLevel {
+    /**
+     * The first heading level.
+     */
+    One = 1,
+    /**
+     * The second heading level.
+     */
+    Two = 2,
+    /**
+     * The third heading level.
+     */
+    Three = 3
+}
+/**
+ * Formats the content into a heading level.
+ *
+ * @typeParam Content - This is inferred by the supplied content
+ * @param content - The content to wrap
+ * @param level - The heading level
+ */
+declare function heading<Content extends string>(content: Content, level?: HeadingLevel.One): `# ${Content}`;
+/**
+ * Formats the content into a heading level.
+ *
+ * @typeParam Content - This is inferred by the supplied content
+ * @param content - The content to wrap
+ * @param level - The heading level
+ */
+declare function heading<Content extends string>(content: Content, level: HeadingLevel.Two): `## ${Content}`;
+/**
+ * Formats the content into a heading level.
+ *
+ * @typeParam Content - This is inferred by the supplied content
+ * @param content - The content to wrap
+ * @param level - The heading level
+ */
+declare function heading<Content extends string>(content: Content, level: HeadingLevel.Three): `### ${Content}`;
+/**
+ * A type that recursively traverses into arrays.
+ */
+type RecursiveArray<ItemType> = readonly (ItemType | RecursiveArray<ItemType>)[];
+/**
+ * Formats the elements in the array to an ordered list.
+ *
+ * @param list - The array of elements to list
+ * @param startNumber - The starting number for the list
+ */
+declare function orderedList(list: RecursiveArray<string>, startNumber?: number): string;
+/**
+ * Formats the elements in the array to an unordered list.
+ *
+ * @param list - The array of elements to list
+ */
+declare function unorderedList(list: RecursiveArray<string>): string;
 /**
  * Formats a date into a short date-time string.
  *
@@ -417,27 +475,27 @@ declare function time(date?: Date): `<t:${bigint}>`;
 /**
  * Formats a date given a format style.
  *
- * @typeParam S - This is inferred by the supplied {@link TimestampStylesString}
+ * @typeParam Style - This is inferred by the supplied {@link TimestampStylesString}
  * @param date - The date to format
  * @param style - The style to use
  */
-declare function time<S extends TimestampStylesString>(date: Date, style: S): `<t:${bigint}:${S}>`;
+declare function time<Style extends TimestampStylesString>(date: Date, style: Style): `<t:${bigint}:${Style}>`;
 /**
  * Formats the given timestamp into a short date-time string.
  *
- * @typeParam C - This is inferred by the supplied timestamp
+ * @typeParam Seconds - This is inferred by the supplied timestamp
  * @param seconds - A Unix timestamp in seconds
  */
-declare function time<C extends number>(seconds: C): `<t:${C}>`;
+declare function time<Seconds extends number>(seconds: Seconds): `<t:${Seconds}>`;
 /**
  * Formats the given timestamp into a short date-time string.
  *
- * @typeParam C - This is inferred by the supplied timestamp
- * @typeParam S - This is inferred by the supplied {@link TimestampStylesString}
+ * @typeParam Seconds - This is inferred by the supplied timestamp
+ * @typeParam Style - This is inferred by the supplied {@link TimestampStylesString}
  * @param seconds - A Unix timestamp in seconds
  * @param style - The style to use
  */
-declare function time<C extends number, S extends TimestampStylesString>(seconds: C, style: S): `<t:${C}:${S}>`;
+declare function time<Seconds extends number, Style extends TimestampStylesString>(seconds: Seconds, style: Style): `<t:${Seconds}:${Style}>`;
 /**
  * The {@link https://discord.com/developers/docs/reference#message-formatting-timestamp-styles | message formatting timestamp styles}
  * supported by Discord.
@@ -507,5 +565,22 @@ declare enum Faces {
      */
     Unflip = "\u252C\u2500\u252C\u30CE( \u00BA _ \u00BA\u30CE)"
 }
+/**
+ * All the available guild navigation mentions.
+ */
+declare enum GuildNavigationMentions {
+    /**
+     * Browse Channels tab.
+     */
+    Browse = "<id:browse>",
+    /**
+     * Customize tab with the server's {@link https://discord.com/developers/docs/resources/guild#guild-onboarding-object | onboarding prompts}.
+     */
+    Customize = "<id:customize>",
+    /**
+     * {@link https://support.discord.com/hc/articles/13497665141655 | Server Guide} tab.
+     */
+    Guide = "<id:guide>"
+}
 
-export { EscapeMarkdownOptions, Faces, TimestampStyles, TimestampStylesString, blockQuote, bold, channelLink, channelMention, chatInputApplicationCommandMention, codeBlock, escapeBold, escapeBulletedList, escapeCodeBlock, escapeEscape, escapeHeading, escapeInlineCode, escapeItalic, escapeMarkdown, escapeMaskedLink, escapeNumberedList, escapeSpoiler, escapeStrikethrough, escapeUnderline, formatEmoji, hideLinkEmbed, hyperlink, inlineCode, italic, messageLink, quote, roleMention, spoiler, strikethrough, time, underscore, userMention };
+export { EscapeMarkdownOptions, Faces, GuildNavigationMentions, HeadingLevel, RecursiveArray, TimestampStyles, TimestampStylesString, blockQuote, bold, channelLink, channelMention, chatInputApplicationCommandMention, codeBlock, escapeBold, escapeBulletedList, escapeCodeBlock, escapeEscape, escapeHeading, escapeInlineCode, escapeItalic, escapeMarkdown, escapeMaskedLink, escapeNumberedList, escapeSpoiler, escapeStrikethrough, escapeUnderline, formatEmoji, heading, hideLinkEmbed, hyperlink, inlineCode, italic, messageLink, orderedList, quote, roleMention, spoiler, strikethrough, time, underscore, unorderedList, userMention };