Preview environment

class Emoji

extends

Base
export class Emoji extends Base

Represents an emoji, see ApplicationEmoji, GuildEmoji and ReactionEmoji.

Constructors

constructor(
client: Client<true>
emoji: RawEmojiData
)

Constructs a new instance of the Emoji class

animated : boolean | null

Whether or not the emoji is animated

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date | null

The time the emoji was created at, or null if unicode

readonly
createdTimestamp : number | null

The timestamp the emoji was created at, or null if unicode

id : Snowflake | null

The emoji's id

readonly
identifier : string

The identifier of this emoji, used for message reactions

name : string | null

The emoji's name

deprecatedreadonly
url : string | null

Returns a URL for the emoji or null if this is not a custom emoji.

imageURL(
options?: BaseImageURLOptions
) : string | null

Returns a URL for the emoji or null if this is not a custom emoji.

toJSON() : unknown

toString() : string

When concatenated with a string, this automatically returns the text required to form a graphical emoji on Discord instead of the Emoji object.

Examples:
// Send a custom emoji from a guild:
const emoji = guild.emojis.cache.first();
msg.channel.send(`Hello! ${emoji}`);
// Send the emoji used in a reaction to the channel the reaction is part of
reaction.message.channel.send(`The emoji used was: ${reaction.emoji}`);

valueOf() : string

Inherited from: Base