EmojiManager
Defined in: packages/managers/src/emoji.ts:28
Manages custom emojis for a guild.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EmojiManager(
rest,guildId):EmojiManager
Defined in: packages/managers/src/emoji.ts:32
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”EmojiManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,Emoji>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,Emoji]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, Emoji]>
Cache iterator.
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”create(
options):Promise<Emoji>
Defined in: packages/managers/src/emoji.ts:61
Creates a new custom emoji.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Emoji>
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
Inherited from
Section titled “Inherited from”edit()
Section titled “edit()”edit(
emojiId,options):Promise<Emoji>
Defined in: packages/managers/src/emoji.ts:73
Edits an existing custom emoji.
Parameters
Section titled “Parameters”emojiId
Section titled “emojiId”string
options
Section titled “options”Returns
Section titled “Returns”Promise<Emoji>
fetch()
Section titled “fetch()”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.
Parameters
Section titled “Parameters”emojiId
Section titled “emojiId”string
Returns
Section titled “Returns”Promise<Emoji>
fetchAll()
Section titled “fetchAll()”fetchAll():
Promise<Emoji[]>
Defined in: packages/managers/src/emoji.ts:53
Fetches all emojis for this guild.
Returns
Section titled “Returns”Promise<Emoji[]>
find()
Section titled “find()”find(
predicate):Emoji|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”Emoji | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
Emoji|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”Emoji | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):Emoji|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”Emoji | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”remove(
emojiId,reason?):Promise<void>
Defined in: packages/managers/src/emoji.ts:88
Deletes a custom emoji.
Parameters
Section titled “Parameters”emojiId
Section titled “emojiId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”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.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”upsert()
Section titled “upsert()”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.
Parameters
Section titled “Parameters”animated?
Section titled “animated?”boolean
available?
Section titled “available?”boolean
string | null
managed?
Section titled “managed?”boolean
string | null
require_colons?
Section titled “require_colons?”boolean
roles?
Section titled “roles?”string[]
Returns
Section titled “Returns”values()
Section titled “values()”values():
Emoji[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”Emoji[]
Array of values.