Skip to content

UserManager

Defined in: packages/managers/src/user.ts:25

Generic REST-backed resource manager.

new UserManager(rest, options?): UserManager

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

REST

number

Most users kept; the least recently used go first. Default: unbounded.

UserManager

ResourceManager.constructor

readonly cache: Collection<string, User>

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

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

ResourceManager.cache

get size(): number

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

Gets cache size.

number

Number of cached values.

ResourceManager.size

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

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

Iterates cached entries.

IterableIterator<[string, User]>

Cache iterator.

ResourceManager.[iterator]


clear(): void

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

Clears the cache.

void

Nothing.

ResourceManager.clear


createDM(userId): Promise<APIChannel>

Defined in: packages/managers/src/user.ts:80

Creates a DM channel with a user.

string

Promise<APIChannel>


delete(id): boolean

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

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

ResourceManager.delete


editMe(options): Promise<User>

Defined in: packages/managers/src/user.ts:45

Modifies the currently logged-in bot user.

UserEditOptions

Promise<User>


fetch(id): Promise<User>

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

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

string

Promise<User>

ResourceManager.fetch


fetchGuilds(options?): Promise<APIPartialGuild[]>

Defined in: packages/managers/src/user.ts:51

Lists the guilds the bot is in, one page at a time (limit 1-200, before / after guild-ID cursors).

string

string

number

boolean

Promise<APIPartialGuild[]>


fetchMany(ids): Promise<User[]>

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

Iterable<string>

Promise<User[]>

ResourceManager.fetchMany


fetchMe(): Promise<User>

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

Gets the currently logged-in bot user.

Promise<User>


find(predicate): User | undefined

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

Finds a cached value.

(value, key) => boolean

Predicate.

User | undefined

Matching value.

ResourceManager.find


first(): User | undefined

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

Gets the first cached value.

User | undefined

First value.

ResourceManager.first


get(id): User | undefined

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

Gets a cached value.

string

Cache key.

User | undefined

Cached value.

ResourceManager.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.

ResourceManager.has


leaveGuild(guildId): Promise<void>

Defined in: packages/managers/src/user.ts:75

Leaves a guild.

string

Promise<void>


resolve(id): Promise<User>

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

string

Promise<User>

ResourceManager.resolve


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.

User

Value.

this

This manager.

ResourceManager.set


update(resource): User

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

User

User

ResourceManager.update


upsert(resource): User

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.

User

User

The canonical instance.

ResourceManager.upsert


values(): User[]

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

Returns cached values.

User[]

Array of values.

ResourceManager.values