UserManager
Defined in: packages/managers/src/user.ts:25
Generic REST-backed resource manager.
Extends
Section titled “Extends”ResourceManager<string,User>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UserManager(
rest,options?):UserManager
Defined in: packages/managers/src/user.ts:28
Parameters
Section titled “Parameters”options?
Section titled “options?”maxSize?
Section titled “maxSize?”number
Most users kept; the least recently used go first. Default: unbounded.
Returns
Section titled “Returns”UserManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,User>
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,User]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, User]>
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”createDM()
Section titled “createDM()”createDM(
userId):Promise<APIChannel>
Defined in: packages/managers/src/user.ts:80
Creates a DM channel with a user.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<APIChannel>
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”editMe()
Section titled “editMe()”editMe(
options):Promise<User>
Defined in: packages/managers/src/user.ts:45
Modifies the currently logged-in bot user.
Parameters
Section titled “Parameters”options
Section titled “options”UserEditOptions
Returns
Section titled “Returns”Promise<User>
fetch()
Section titled “fetch()”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.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<User>
Inherited from
Section titled “Inherited from”fetchGuilds()
Section titled “fetchGuilds()”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).
Parameters
Section titled “Parameters”options?
Section titled “options?”after?
Section titled “after?”string
before?
Section titled “before?”string
limit?
Section titled “limit?”number
withCounts?
Section titled “withCounts?”boolean
Returns
Section titled “Returns”Promise<APIPartialGuild[]>
fetchMany()
Section titled “fetchMany()”fetchMany(
ids):Promise<User[]>
Defined in: packages/managers/src/base.ts:158
Parameters
Section titled “Parameters”Iterable<string>
Returns
Section titled “Returns”Promise<User[]>
Inherited from
Section titled “Inherited from”fetchMe()
Section titled “fetchMe()”fetchMe():
Promise<User>
Defined in: packages/managers/src/user.ts:39
Gets the currently logged-in bot user.
Returns
Section titled “Returns”Promise<User>
find()
Section titled “find()”find(
predicate):User|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”User | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
User|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”User | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):User|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”User | 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”leaveGuild()
Section titled “leaveGuild()”leaveGuild(
guildId):Promise<void>
Defined in: packages/managers/src/user.ts:75
Leaves a guild.
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”Promise<void>
resolve()
Section titled “resolve()”resolve(
id):Promise<User>
Defined in: packages/managers/src/base.ts:145
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<User>
Inherited from
Section titled “Inherited from”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”update()
Section titled “update()”update(
resource):User
Defined in: packages/managers/src/base.ts:180
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”upsert()
Section titled “upsert()”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.
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”The canonical instance.
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
User[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”User[]
Array of values.