Class Embed

constructor

• new Embed(
      data?:
          | EmbedBuilderCacheJSON
          | EmbedBuilderStorageJSON
          | EmbedBuilderDiscordJSON
          | APIEmbed,
  ): Embed

  Creates an embed structure.

  Parameters

  • Optionaldata:
        | EmbedBuilderCacheJSON
        | EmbedBuilderStorageJSON
        | EmbedBuilderDiscordJSON
        | APIEmbed

    The embed data.

    • EmbedBuilderCacheJSON

      • title

        The title of the embed.

      • description

        The description of the embed.

      • url

        The url of the embed.

      • timestamp

        The timestamp of the embed.

      • color

        The color of the embed.

      • footer

        The footer of the embed.

      • footer.text

        The footer text.

      • footer.icon_url

        The footer icon url.

      • author

        The author of the embed.

      • author.name

        The author name.

      • author.url

        The author url.

      • author.icon_url

        The author icon url.

      • fields

        The fields of the embed.

      • fields.name

        The field name.

      • fields.value

        The field value.

      • fields.inline

        Whether the field should be inline.

      • image

        The image of the embed.

      • image.url

        The image url.

      • thumbnail

        The thumbnail of the embed.

      • thumbnail.url

        The thumbnail url.

      • video

        The video of the embed.

      • video.url

        The video url.

    • EmbedBuilderStorageJSON

      • title

        The title of the embed.

      • description

        The description of the embed.

      • url

        The url of the embed.

      • timestamp

        The timestamp of the embed.

      • color

        The color of the embed.

      • footer

        The footer of the embed.

      • footer.text

        The footer text.

      • footer.icon_url

        The footer icon url.

      • author

        The author of the embed.

      • author.name

        The author name.

      • author.url

        The author url.

      • author.icon_url

        The author icon url.

      • fields

        The fields of the embed.

      • fields.name

        The field name.

      • fields.value

        The field value.

      • fields.inline

        Whether the field should be inline.

      • image

        The image of the embed.

      • image.url

        The image url.

      • thumbnail

        The thumbnail of the embed.

      • thumbnail.url

        The thumbnail url.

      • video

        The video of the embed.

      • video.url

        The video url.

    • EmbedBuilderDiscordJSON

      • title

        The title of the embed.

      • description

        The description of the embed.

      • url

        The url of the embed.

      • timestamp

        The timestamp of the embed.

      • color

        The color of the embed.

      • footer

        The footer of the embed.

      • footer.text

        The footer text.

      • footer.icon_url

        The footer icon url.

      • author

        The author of the embed.

      • author.name

        The author name.

      • author.url

        The author url.

      • author.icon_url

        The author icon url.

      • fields

        The fields of the embed.

      • fields.name

        The field name.

      • fields.value

        The field value.

      • fields.inline

        Whether the field should be inline.

      • image

        The image of the embed.

      • image.url

        The image url.

      • thumbnail

        The thumbnail of the embed.

      • thumbnail.url

        The thumbnail url.

      • video

        The video of the embed.

      • video.url

        The video url.

    • APIEmbed

      • title

        The title of the embed.

      • description

        The description of the embed.

      • url

        The url of the embed.

      • timestamp

        The timestamp of the embed.

      • color

        The color of the embed.

      • footer

        The footer of the embed.

      • footer.text

        The footer text.

      • footer.icon_url

        The footer icon url.

      • author

        The author of the embed.

      • author.name

        The author name.

      • author.url

        The author url.

      • author.icon_url

        The author icon url.

      • fields

        The fields of the embed.

      • fields.name

        The field name.

      • fields.value

        The field value.

      • fields.inline

        Whether the field should be inline.

      • image

        The image of the embed.

      • image.url

        The image url.

      • thumbnail

        The thumbnail of the embed.

      • thumbnail.url

        The thumbnail url.

      • video

        The video of the embed.

      • video.url

        The video url.

  Returns Embed

author

color

description

fields

footer

image

thumbnail

timestamp

title

url

video

characterCount

• get characterCount(): number

  Returns the character count of the embed.

  Returns number

addField

• addField(name: string, value: string, inline?: boolean): Embed

  Adds a field to the embed.

  Parameters

  • name: string

    Sets the embed field name.
  • value: string

    Sets the embed field value.
  • inline: boolean = false

    Whether this field should be displayed inline.

  Returns Embed

  Throws

  Method

setAuthor

• setAuthor(name: string, url?: null | string, icon_url?: null | string): Embed

  Sets the embed author info.

  Parameters

  • name: string

    The embed author.
  • Optionalurl: null | string

    The url.
  • Optionalicon_url: null | string

    The embed author image url.

  Returns Embed

  Throws

  Method

setColor

• setColor(color: string | number): Embed

  Sets the color of the embed.

  Parameters

  • color: string | number

    The color.

  Returns Embed

  Throws

  Method

setDescription

• setDescription(text: string): Embed

  Sets the embed description.

  Parameters

  • text: string

    The description.

  Returns Embed

  Throws

  Method

setFooter

• setFooter(text: string, icon?: null | string): Embed

  Sets the embed footer.

  Parameters

  • text: string

    The footer text.
  • Optionalicon: null | string

    The url of the footer icon.

  Returns Embed

  Throws

  Method

setImage

• setImage(url: string): Embed

  Sets the embed image url.

  Parameters

  • url: string

    The image url.

  Returns Embed

  Method

setThumbnail

• setThumbnail(url: string): Embed

  Sets the embed thumbnail image.

  Parameters

  • url: string

    The url of the thumbnail.

  Returns Embed

  Throws

  Method

setTimestamp

• setTimestamp(timestamp?: number): Embed

  Sets the timestamp displayed on the embed.

  Parameters

  • Optionaltimestamp: number

    The UNIX timestamp.

  Returns Embed

  Method

setTitle

• setTitle(title: string): Embed

  Sets the title of the embed.

  Parameters

  • title: string

    The title of the embed.

  Returns Embed

  Throws

  Method

setURL

• setURL(url: string): Embed

  Sets the url of the embed.

  Parameters

  • url: string

    The url.

  Returns Embed

  Throws

  Method

setVideo

• setVideo(url: string): Embed

  Sets the embed video url.

  Parameters

  • url: string

    The video url.

  Returns Embed

  Method

toJSON

• toJSON(
      format?: JsonTypes,
      __namedParameters?: { suppressValidation: boolean },
  ):
      | {
          author: undefined
          | APIEmbedAuthor;
          color: undefined | number;
          description: undefined | string;
          fields: APIEmbedField[];
          footer: undefined | APIEmbedFooter;
          image: undefined | APIEmbedImage;
          thumbnail: undefined | APIEmbedThumbnail;
          timestamp: undefined | number;
          title: undefined | string;
          url: undefined | string;
          video: undefined | APIEmbedVideo;
      }
      | {
          author: undefined
          | APIEmbedAuthor;
          color: undefined | number;
          description: undefined | string;
          fields: APIEmbedField[];
          footer: undefined | APIEmbedFooter;
          image: undefined | APIEmbedImage;
          thumbnail: undefined | APIEmbedThumbnail;
          timestamp: undefined | string;
          title: undefined | string;
          url: undefined | string;
          video: undefined | APIEmbedVideo;
      }

  Returns the correct Discord format for an embed.

  Parameters

  • Optionalformat: JsonTypes
  • __namedParameters: { suppressValidation: boolean } = ...

  Returns
      | {
          author: undefined
          | APIEmbedAuthor;
          color: undefined | number;
          description: undefined | string;
          fields: APIEmbedField[];
          footer: undefined | APIEmbedFooter;
          image: undefined | APIEmbedImage;
          thumbnail: undefined | APIEmbedThumbnail;
          timestamp: undefined | number;
          title: undefined | string;
          url: undefined | string;
          video: undefined | APIEmbedVideo;
      }
      | {
          author: undefined
          | APIEmbedAuthor;
          color: undefined | number;
          description: undefined | string;
          fields: APIEmbedField[];
          footer: undefined | APIEmbedFooter;
          image: undefined | APIEmbedImage;
          thumbnail: undefined | APIEmbedThumbnail;
          timestamp: undefined | string;
          title: undefined | string;
          url: undefined | string;
          video: undefined | APIEmbedVideo;
      }

  Method

toString

• toString(): string

  Converts the embed into string form.

  Returns string

  Method