Skip to content

ResourceManager

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

Generic REST-backed resource manager.

K

Resource key type.

V

Resource type.

new ResourceManager<K, V>(fetcher, key, maxSize?): ResourceManager<K, V>

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

(id) => Promise<V>

(value) => K

number

ResourceManager<K, V>

Manager.constructor

readonly cache: Collection<K, V>

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<[K, V]>

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

Iterates cached entries.

IterableIterator<[K, V]>

Cache iterator.

Manager.[iterator]


clear(): void

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

Clears the cache.

void

Nothing.

Manager.clear


delete(id): boolean

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

Deletes a cached value.

K

Cache key.

boolean

True when deleted.

Manager.delete


fetch(id): Promise<V>

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

Fetches from Discord; a cached instance is updated in place, so references to it stay current.

K

Promise<V>


fetchMany(ids): Promise<V[]>

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

Iterable<K>

Promise<V[]>


find(predicate): V | undefined

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

Finds a cached value.

(value, key) => boolean

Predicate.

V | undefined

Matching value.

Manager.find


first(): V | undefined

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

Gets the first cached value.

V | undefined

First value.

Manager.first


get(id): V | undefined

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

Gets a cached value.

K

Cache key.

V | undefined

Cached value.

Manager.get


has(id): boolean

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

Checks whether a value is cached.

K

Cache key.

boolean

True when cached.

Manager.has


resolve(id): Promise<V>

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

K

Promise<V>


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.

K

Cache key.

V

Value.

this

This manager.

Manager.set


update(resource): V

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

V

V


upsert(resource): V

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

Stores a resource, merging into the cached instance when there is one so existing references stay current.

V

V

The canonical instance.


values(): V[]

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

Returns cached values.

V[]

Array of values.

Manager.values