Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Properties

default

default: { errorEmbed: (errorMessage: string, details?: string, emoji?: EmojiResolvable) => MessageEmbed; simpleEmbed: (title: string, color?: ColorResolvable, options?: { description?: string; emoji?: EmojiResolvable }) => MessageEmbed; successEmbed: (message: string, details?: string, emoji?: EmojiResolvable) => MessageEmbed }

Type declaration

  • errorEmbed: (errorMessage: string, details?: string, emoji?: EmojiResolvable) => MessageEmbed
      • (errorMessage: string, details?: string, emoji?: EmojiResolvable): MessageEmbed
      • Makes an embed for reporting an error

        Parameters

        • errorMessage: string

          The error message to display

        • Optional details: string

          Optional details to include in the message

        • Optional emoji: EmojiResolvable

          Emoji to include in the title

        Returns MessageEmbed

        The created embed

  • simpleEmbed: (title: string, color?: ColorResolvable, options?: { description?: string; emoji?: EmojiResolvable }) => MessageEmbed
      • (title: string, color?: ColorResolvable, options?: { description?: string; emoji?: EmojiResolvable }): MessageEmbed
      • Makes a simple embed with a title and description

        Parameters

        • title: string

          The title of the embed

        • color: ColorResolvable = 'BLUE'

          The color of the embed (default: blue)

        • Optional options: { description?: string; emoji?: EmojiResolvable }

          Extra options like description and emoji

          • Optional description?: string
          • Optional emoji?: EmojiResolvable

        Returns MessageEmbed

        The created embed

  • successEmbed: (message: string, details?: string, emoji?: EmojiResolvable) => MessageEmbed
      • (message: string, details?: string, emoji?: EmojiResolvable): MessageEmbed
      • Makes an embed for sending a success message

        Parameters

        • message: string

          The success message to display

        • Optional details: string

          Optional details to include in the message

        • Optional emoji: EmojiResolvable

          Emoji to include in the title

        Returns MessageEmbed

        The created embed

Functions

Const errorEmbed

  • errorEmbed(errorMessage: string, details?: string, emoji?: EmojiResolvable): MessageEmbed
  • Makes an embed for reporting an error

    Parameters

    • errorMessage: string

      The error message to display

    • Optional details: string

      Optional details to include in the message

    • Optional emoji: EmojiResolvable

      Emoji to include in the title

    Returns MessageEmbed

    The created embed

Const simpleEmbed

  • simpleEmbed(title: string, color?: ColorResolvable, options?: { description?: string; emoji?: EmojiResolvable }): MessageEmbed
  • Makes a simple embed with a title and description

    Parameters

    • title: string

      The title of the embed

    • color: ColorResolvable = 'BLUE'

      The color of the embed (default: blue)

    • Optional options: { description?: string; emoji?: EmojiResolvable }

      Extra options like description and emoji

      • Optional description?: string
      • Optional emoji?: EmojiResolvable

    Returns MessageEmbed

    The created embed

Const successEmbed

  • successEmbed(message: string, details?: string, emoji?: EmojiResolvable): MessageEmbed
  • Makes an embed for sending a success message

    Parameters

    • message: string

      The success message to display

    • Optional details: string

      Optional details to include in the message

    • Optional emoji: EmojiResolvable

      Emoji to include in the title

    Returns MessageEmbed

    The created embed

Generated using TypeDoc