Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Embed

Represents a rich embed in a message.

Hierarchy

  • MessageEmbed
    • Embed

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional embedResolvable: null | EmbedResolvable

      The embed resolvable.

    • options: Partial<EmbedOptions> = {}

      The options for the embed.

    • data: MessageEmbed | MessageEmbedOptions = {}

      The data of the embed.

    Returns Embed

Properties

author

author: null | MessageEmbedAuthor

color

color: null | number

Readonly createdAt

createdAt: null | Date

description

description: null | string

fields

fields: EmbedField[]

footer

footer: null | MessageEmbedFooter

Readonly hexColor

hexColor: null | `#${string}`

image

image: null | MessageEmbedImage

Readonly length

length: number

options

options: EmbedOptions

provider

provider: null | MessageEmbedProvider

thumbnail

thumbnail: null | MessageEmbedThumbnail

timestamp

timestamp: null | number

title

title: null | string

type

type: string
deprecated

url

url: null | string

Readonly video

video: null | MessageEmbedVideo

Methods

addField

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

  • Adds a field to the embed (max 25).

    Parameters

    • name: string

      The name of this field

    • value: string

      The value of this field

    • inline: boolean = false

      If this field will be displayed inline

    Returns Embed

    This?

addFields

  • addFields(...fields: EmbedFieldData[]): Embed

  • Adds fields to the embed (max 25).

    Parameters

    • Rest ...fields: EmbedFieldData[]

      The fields to add

    Returns Embed

    This?

equals

  • equals(embed: MessageEmbed | APIEmbed): boolean

  • Parameters

    • embed: MessageEmbed | APIEmbed

    Returns boolean

resolveImage

  • Resolves an icon

    Parameters

    • resolvable: EmbedInput

      The resolvable to be resolved

    Returns string

    The resolved image url

setAuthor

  • Sets the author of this embed.

    Parameters

    Returns Embed

    {this}

setColor

  • setColor(color: ColorResolvable): Embed

  • Parameters

    • color: ColorResolvable

    Returns Embed

setDescription

  • setDescription(description: string): Embed

  • Sets the description of this embed.

    Parameters

    • description: string

      The description

    Returns Embed

    This?

setError

  • Sets the color of this embed to red

    Returns Embed

    This?

setFields

  • setFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Embed

  • Parameters

    • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

    Returns Embed

setFooter

  • Sets the footer of this embed.

    memberof

    Embed

    Parameters

    Returns Embed

    {this}

setImage

  • Sets the image of this embed.

    Parameters

    Returns Embed

    This?

setTemplate

  • setTemplate(user: User): void

  • Parameters

    • user: User

    Returns void

setThumbnail

  • Sets the thumbnail of this embed.

    Parameters

    Returns Embed

    This?

setTimestamp

  • setTimestamp(timestamp?: null | number | Date): Embed

  • Parameters

    • Optional timestamp: null | number | Date

    Returns Embed

setTitle

  • setTitle(title: string): Embed

  • Sets the title of this embed.

    Parameters

    • title: string

      The title

    Returns Embed

    This?

setURL

  • setURL(url: string): Embed

  • Parameters

    • url: string

    Returns Embed

spliceFields

  • spliceFields(index: number, deleteCount: number, ...fields: EmbedFieldData[] | EmbedFieldData[][]): Embed

  • Parameters

    • index: number
    • deleteCount: number
    • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

    Returns Embed

toJSON

  • toJSON(): APIEmbed

  • Returns APIEmbed

Static hasSupport

  • hasSupport(resolvable: any): boolean

  • No idea what this does probably shouldn't touch it.

    static
    memberof

    Embed

    Parameters

    • resolvable: any

      The resolvable

    Returns boolean

    A Boolean

Static normalizeField

  • normalizeField(name: string, value: string, inline?: boolean): Required<EmbedFieldData>

  • Parameters

    • name: string
    • value: string
    • Optional inline: boolean

    Returns Required<EmbedFieldData>

Static normalizeFields

  • normalizeFields(...fields: EmbedFieldData[] | EmbedFieldData[][]): Required<EmbedFieldData>[]

  • Parameters

    • Rest ...fields: EmbedFieldData[] | EmbedFieldData[][]

    Returns Required<EmbedFieldData>[]

Static resolveName

  • Resolves a name

    Parameters

    • resolvable: EmbedInput

      The resolvable to be resolved

    Returns string

    The resolved name