Skip to content

EmojiManager

Defined in: packages/managers/src/emoji.ts:28

Manages custom emojis for a guild.

new EmojiManager(rest, guildId): EmojiManager

Defined in: packages/managers/src/emoji.ts:32

REST

string

EmojiManager

Manager.constructor

readonly cache: Collection<string, Emoji>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

Manager.cache

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

Manager.size

[iterator](): IterableIterator<[string, Emoji]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, Emoji]>

Cache iterator.

Manager.[iterator]


clear(): void

Defined in: packages/managers/src/base.ts:101

Clears the cache.

void

Nothing.

Manager.clear


create(options): Promise<Emoji>

Defined in: packages/managers/src/emoji.ts:61

Creates a new custom emoji.

EmojiCreateOptions

Promise<Emoji>


delete(id): boolean

Defined in: packages/managers/src/base.ts:96

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

Manager.delete


edit(emojiId, options): Promise<Emoji>

Defined in: packages/managers/src/emoji.ts:73

Edits an existing custom emoji.

string

EmojiEditOptions

Promise<Emoji>


fetch(emojiId): Promise<Emoji>

Defined in: packages/managers/src/emoji.ts:39

Fetches an emoji by ID; concurrent fetches share a request and a stale result never overwrites newer state.

string

Promise<Emoji>


fetchAll(): Promise<Emoji[]>

Defined in: packages/managers/src/emoji.ts:53

Fetches all emojis for this guild.

Promise<Emoji[]>


find(predicate): Emoji | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

Emoji | undefined

Matching value.

Manager.find


first(): Emoji | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

Emoji | undefined

First value.

Manager.first


get(id): Emoji | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

Emoji | undefined

Cached value.

Manager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

Manager.has


remove(emojiId, reason?): Promise<void>

Defined in: packages/managers/src/emoji.ts:88

Deletes a custom emoji.

string

string

Audit-log reason.

Promise<void>


set(id, value): this

Defined in: packages/managers/src/base.ts:88

Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.

string

Cache key.

Emoji

Value.

this

This manager.

Manager.set


upsert(data): Emoji

Defined in: packages/managers/src/emoji.ts:98

Upserts an emoji into the manager cache. Custom emojis are keyed by their snowflake ID; unicode emojis (no ID) are keyed by unicode:${name} so repeated upserts reuse the same cached instance instead of allocating a new one each call.

boolean

boolean

string | null

boolean

string | null

boolean

string[]

UserData

Emoji


values(): Emoji[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

Emoji[]

Array of values.

Manager.values