Preview environment

class Embed

export class Embed

Represents an embed.

readonly
author : EmbedAuthorData | null

The author of this embed.

readonly
color : number | null

The color of this embed.

readonly
data : Readonly<APIEmbed>

The API embed data.

readonly
description : string | null

The description of this embed.

readonly
fields : APIEmbedField[]

An array of fields of this embed.

The footer of this embed.

readonly
hexColor : string | null

The hex color of this embed.

readonly
image : EmbedAssetData | null

The image of this embed.

readonly
length : number

The accumulated length for the embed title, description, fields, footer text, and author name.

readonly
provider : APIEmbedProvider | null

The provider of this embed.

readonly
thumbnail : EmbedAssetData | null

The thumbnail of this embed.

readonly
timestamp : string | null

The timestamp of this embed. This is in an ISO 8601 format.

readonly
title : string | null

The title of this embed.

readonly
url : string | null

The URL of this embed.

readonly
video : EmbedAssetData | null

The video of this embed.

equals(
other: Embed | APIEmbed
) : boolean

Whether the given embeds are equal.

toJSON() : APIEmbed

Returns the API-compatible JSON for this embed.