Class Embeds

constructor

• new Embeds(options): Embeds

• Parameters

  • options: EmbedsOptions

  Returns Embeds

brandingOptions

colors

emojis

includeTimestamp

timestampInline

timestampSmall

applyTimestamp

• applyTimestamp(embed): EmbedBuilder

• Parameters

  • embed: EmbedBuilder

  Returns EmbedBuilder

branding

• branding(data): EmbedBuilder

• Parameters

  • data: CreateEmbedData

  Returns EmbedBuilder

build

• build(data): EmbedBuilder

• Parameters

  • data: CreateEmbedData

  Returns EmbedBuilder

debug

• debug(data): EmbedBuilder

• Parameters

  • data: CreateStatusEmbedData

  Returns EmbedBuilder

error

• error(data): EmbedBuilder

• Parameters

  • data: CreateStatusEmbedData

  Returns EmbedBuilder

info

• info(data): EmbedBuilder

• Parameters

  • data: CreateStatusEmbedData

  Returns EmbedBuilder

resolveEmbedColor

• resolveEmbedColor(color?): number

• Parameters

  • Optional color: number | (keyof IColors)

  Returns number

status

• status(status, data): EmbedBuilder

• Parameters

  • status: EmbedStatus
  • data: CreateStatusEmbedData

  Returns EmbedBuilder

success

• success(data): EmbedBuilder

• Parameters

  • data: CreateStatusEmbedData

  Returns EmbedBuilder

waiting

• waiting(data): EmbedBuilder

• Parameters

  • data: CreateStatusEmbedData

  Returns EmbedBuilder

warning

• warning(data): EmbedBuilder

• Parameters

  • data: CreateStatusEmbedData

  Returns EmbedBuilder

Static Readonly extractCodeblockDescription

• extractCodeblockDescription(embed): undefined | string

• Extracts the description from an embed, removing the custom header these embeds have in the description, and the codeblock.

  The following structure is expected (all in description field):

  • title
  • (codeblock start) ```
  • ...description
  • (codeblock end) ```

  Parameters

  • embed: EmbedBuilder

  Returns undefined | string

Static Readonly extractDescription

• extractDescription(embed): undefined | string

• Extracts the description from an embed, removing the custom header these embeds have in the description.

  Parameters

  • embed: EmbedBuilder

  Returns undefined | string