Preview environment

class BaseGuildEmoji

extends

Emoji
export class BaseGuildEmoji extends Emoji

Parent class for GuildEmoji and GuildPreviewEmoji.

Constructors

constructor(
client: Client<true>
data: RawGuildEmojiData
guild: Guild | GuildPreview
)

Constructs a new instance of the BaseGuildEmoji class

animated : boolean | null

Whether or not the emoji is animated

Inherited from: Emoji

available : boolean | null

Whether this emoji is available

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

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

readonly
createdTimestamp : number

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

guild : Guild | GuildPreview

The guild this emoji is a part of

id : Snowflake

The emoji's id

readonly
identifier : string

The identifier of this emoji, used for message reactions

Inherited from: Emoji

managed : boolean | null

Whether this emoji is managed by an external service

name : string | null

The emoji's name

Inherited from: Emoji

requiresColons : boolean | null

Whether or not this emoji requires colons surrounding it

deprecatedreadonly
url : string

Returns a URL for the emoji.

imageURL(
options?: BaseImageURLOptions
) : string

Returns a URL for the emoji.

toJSON() : unknown

Inherited from: Emoji

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}`);

Inherited from: Emoji

valueOf() : string

Inherited from: Base