Manager
Defined in: packages/managers/src/base.ts:25
Generic cache manager.
Extended by
Section titled “Extended by”ChannelManagerResourceManagerGuildBanManagerGuildScheduledEventManagerStageInstanceManagerEmojiManagerGuildStickerManagerGuildSoundboardManagerMonetizationManagerApplicationEmojiManager
Type Parameters
Section titled “Type Parameters”K
Cache key type.
V
Cached value type.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Manager<
K,V>(maxSize?):Manager<K,V>
Defined in: packages/managers/src/base.ts:31
Parameters
Section titled “Parameters”maxSize?
Section titled “maxSize?”number
Most entries kept; the least recently used go first. Default: unbounded.
Returns
Section titled “Returns”Manager<K, V>
Properties
Section titled “Properties”
readonlycache:Collection<K,V>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
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.
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[K,V]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[K, V]>
Cache iterator.
clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”K
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
find()
Section titled “find()”find(
predicate):V|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”V | undefined
Matching value.
first()
Section titled “first()”first():
V|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”V | undefined
First value.
get(
id):V|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”K
Cache key.
Returns
Section titled “Returns”V | undefined
Cached value.
has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”K
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
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”K
Cache key.
V
Value.
Returns
Section titled “Returns”this
This manager.
values()
Section titled “values()”values():
V[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”V[]
Array of values.