GuildEmoji

A GuildEmoji is a custom emoji of a server. You get one from guild.emojis, guild.fetchEmojis() or guild.createEmoji(). Putting one in a text shows it.

import type { Guild } from 'chapterjs';

async function welcome(guild: Guild) {
  const emoji = [...guild.emojis.values()].find(emoji => emoji.name === 'party');
  const channel = guild.channels.get(guild.systemChannelId ?? '');
  if (!emoji || !channel?.isTextBased()) return;
  await channel.send(`Welcome! ${emoji}`);
}

How to put an emoji in a message or react with one is in Messages. A standard emoji (🎉) is a text, not a GuildEmoji.

Properties

Snowflake

The unique id Discord gave it.

Date

When it was created: a Discord id contains its creation date.

Snowflake

The id of the server of the emoji.

string

The name of the emoji, without the colons.

boolean

Whether the emoji moves.

boolean

false when the server lost the boosts that gave it this emoji.

boolean

Whether the emoji belongs to an integration.

readonly Snowflake[]

The ids of the roles allowed to use the emoji; empty for everyone.

Helpers

These read what the bot remembers: they never send a request.

url()

url(options?: ImageOptions): string

The URL of the image of the emoji. See ImageOptions.

toString()

toString(): string

<:name:id>: shows the emoji when put in a message.

toJSON()

toJSON(): object

The data of Discord as a plain object, with camelCase names.

Actions

edit()

edit(
  options: { name?: string; roles?: (Snowflake | { id: Snowflake })[] | null },
  reason?: string
): Promise<GuildEmoji>

Renames the emoji, or changes which roles can use it. Discord documentation

delete()

delete(reason?: string): Promise<void>

Deletes the emoji. Discord documentation

Types

ImageOptions is in Helpers. To add an emoji to a server, see guild.createEmoji().

Reference

Your files

Structures

Types

CLI

Properties

Helpers

url()

toString()

toJSON()

Actions

edit()

delete()

Types