Variable FormatterConst

Type declaration

• blockQuote: function

  • blockQuote(content: string): string

    Formats content into a quote.

    Parameters

    • content: string

      The content to format.

    Returns string

    The formatted content.

• bold: function

  • bold(content: string): `**${string}**`

    Formats content into bold text.

    Parameters

    • content: string

      The content to format.

    Returns `**${string}**`

    The formatted content.

• channelLink: function

  • channelLink(channelId: string, guildId?: string): string

    Formats a channel link.

    Parameters

    • channelId: string

      The ID of the channel.
    • OptionalguildId: string

      The ID of the guild. Defaults to '@me'.

    Returns string

    The formatted channel link.

• channelMention: function

  • channelMention(channelId: string): `<#${string}>`

    Formats a channel mention.

    Parameters

    • channelId: string

      The ID of the channel to mention.

    Returns `<#${string}>`

    The formatted channel mention.

• codeBlock: function

  • codeBlock(content: string, language?: string): string

    Formats a code block.

    Parameters

    • content: string

      The content of the code block.
    • language: string = 'txt'

      The language of the code block. Defaults to 'txt'.

    Returns string

    The formatted code block.

• emojiMention: function

  • emojiMention(emojiId: string, name: null | string, animated?: boolean): string

    Formats an emoji.

    Parameters

    • emojiId: string

      The ID of the emoji.
    • name: null | string
    • animated: boolean = false

      Whether the emoji is animated. Defaults to false.

    Returns string

    The formatted emoji.

• generateOAuth2URL: function

  • generateOAuth2URL(applicationId: string, options: OAuth2URLOptions): string

    Forms a oauth2 invite link for the bot.

    Parameters

    • applicationId: string

      The ID of the application.
    • options: OAuth2URLOptions

      Options for forming the invite link.

      • scopes

        Oauth2 scopes to be used.

      • disableGuildSelect

        Whether or not guild select must be disabled in oauth2 interface.

      • permissions

        Permissions to be granted to the application.

    Returns string

• header: function

  • header(content: string, level?: HeadingLevel): string

    Formats a header.

    Parameters

    • content: string

      The content of the header.
    • level: HeadingLevel = HeadingLevel.H1

      The level of the header. Defaults to 1.

    Returns string

    The formatted header.

• hyperlink: function

  • hyperlink(content: string, url: string): `[${string}](${string})`

    Formats content into a hyperlink.

    Parameters

    • content: string

      The content to format.
    • url: string

      The URL to hyperlink to.

    Returns `[${string}](${string})`

    The formatted content.

• inlineCode: function

  • inlineCode(content: string): ``${string}``

    Formats content into inline code.

    Parameters

    • content: string

      The content to format.

    Returns ``${string}``

    The formatted content.

• italic: function

  • italic(content: string): `*${string}*`

    Formats content into italic text.

    Parameters

    • content: string

      The content to format.

    Returns `*${string}*`

    The formatted content.

• list: function

  • list(items: string[], ordered?: boolean): string

    Formats a list.

    Parameters

    • items: string[]

      The items of the list.
    • ordered: boolean = false

      Whether the list is ordered. Defaults to false.

    Returns string

    The formatted list.

• messageLink: function

  • messageLink(
        guildId: string,
        channelId: string,
        messageId: string,
    ): `https://discord.com/channels/${string}/${string}/${string}`

    Formats a message link.

    Parameters

    • guildId: string

      The ID of the guild.
    • channelId: string

      The ID of the channel.
    • messageId: string

      The ID of the message.

    Returns `https://discord.com/channels/${string}/${string}/${string}`

    The formatted message link.

• quote: function

  • quote(content: string): string

    Formats content into a quote.

    Parameters

    • content: string

      The content to format.

    Returns string

    The formatted content.

• roleMention: function

  • roleMention(roleId: string): `<@&${string}>`

    Formats a role mention.

    Parameters

    • roleId: string

      The ID of the role to mention.

    Returns `<@&${string}>`

    The formatted role mention.

• spoiler: function

  • spoiler(content: string): `||${string}||`

    Formats content into a spoiler.

    Parameters

    • content: string

      The content to format.

    Returns `||${string}||`

    The formatted content.

• strikeThrough: function

  • strikeThrough(content: string): `~~${string}~~`

    Formats content into strikethrough text.

    Parameters

    • content: string

      The content to format.

    Returns `~~${string}~~`

    The formatted content.

• timestamp: function

  • timestamp(
        timestamp: Date,
        style?: TimestampStyle,
    ):
        | `<t:${number}:t>`
        | `<t:${number}:T>`
        | `<t:${number}:d>`
        | `<t:${number}:D>`
        | `<t:${number}:f>`
        | `<t:${number}:F>`
        | `<t:${number}:R>`

    Formats the given timestamp into discord unix timestamp format.

    Parameters

    • timestamp: Date

      The timestamp to format.
    • style: TimestampStyle = TimestampStyle.RelativeTime

      The style of the timestamp. Defaults to 't'.

    Returns
        | `<t:${number}:t>`
        | `<t:${number}:T>`
        | `<t:${number}:d>`
        | `<t:${number}:D>`
        | `<t:${number}:f>`
        | `<t:${number}:F>`
        | `<t:${number}:R>`

    The formatted timestamp.

• underline: function

  • underline(content: string): `__${string}__`

    Formats content into underlined text.

    Parameters

    • content: string

      The content to format.

    Returns `__${string}__`

    The formatted content.

• userMention: function

  • userMention(userId: string): `<@${string}>`

    Formats a user mention.

    Parameters

    • userId: string

      The ID of the user to mention.

    Returns `<@${string}>`

    The formatted user mention.