Class UserManager

Manages all the users belonging to a client.

Hierarchy (View Summary)

BaseCacheManager<UserType>
- UserManager

Implements

UserManager

Index

Constructors

Properties

identifier rules

Accessors

Methods

_intervalCallback #_callFetches #_callRules #addToExpiryBucket #clearStaleBuckets clear delete expireBucket fetch fetchFromRules fetchWithRules flagForDeletion forEach get has map set toJSON fetchUser

Constructors

constructor

new UserManager(client: Client): UserManager
Creates a user manager.
Parameters
- client: Client
  The client instance.
Returns UserManager
Overrides BaseCacheManager.constructor
- Defined in src/managers/UserManager.ts:24

Properties

`Static`identifier

identifier: StructureIdentifiers = ...

`Static`rules

rules: GluonCacheRuleSetStructure<any> = {}

Accessors

size

get size(): number
Returns the size of the cache.

Returns number
Implementation of UserManagerType.size
Inherited from BaseCacheManager.size
- Defined in src/managers/BaseCacheManager.ts:303

Methods

_intervalCallback

_intervalCallback(): { i: StructureIdentifiers }
The callback for expiring buckets.

Returns { i: StructureIdentifiers }
Method
Implementation of UserManagerType._intervalCallback
Inherited from BaseCacheManager._intervalCallback
- Defined in src/managers/BaseCacheManager.ts:251

#_callFetches

"#_callFetches"(id: string): Promise<null | User>
Calls all the custom fetches.
Parameters
- id: string
  The ID to fetch.
Returns Promise<null | User>
Method
Async
Inherited from BaseCacheManager.#_callFetches
- Defined in src/managers/BaseCacheManager.ts:285

#_callRules

"#_callRules"(value: unknown): void
Calls the rules on a value.
Parameters
- value: unknown
  The value to call the rules on.
Returns void
Method
Inherited from BaseCacheManager.#_callRules
- Defined in src/managers/BaseCacheManager.ts:268

#addToExpiryBucket

"#addToExpiryBucket"(key: string, expiry: number): void
Adds a key to the expiry bucket.
Parameters
- key: string
  The key to add to the expiry bucket.
- expiry: number
  The expiry time in seconds.
Returns void
Method
Inherited from BaseCacheManager.#addToExpiryBucket
- Defined in src/managers/BaseCacheManager.ts:158

#clearStaleBuckets

"#clearStaleBuckets"(): void
Clears stale buckets.

Returns void
Method
Inherited from BaseCacheManager.#clearStaleBuckets
- Defined in src/managers/BaseCacheManager.ts:195

clear

clear(): void
Clears the cache.

Returns void
Method
Implementation of UserManagerType.clear
Inherited from BaseCacheManager.clear
- Defined in src/managers/BaseCacheManager.ts:241

delete

delete(key: string): boolean
Deletes a key from the cache.
Parameters
- key: string
  The key to delete.
Returns boolean
Whether the key was deleted or not.

Method
Implementation of UserManagerType.delete
Inherited from BaseCacheManager.delete
- Defined in src/managers/BaseCacheManager.ts:224

expireBucket

expireBucket(bucket: string): void
Expires a bucket.
Parameters
- bucket: string
  The bucket to expire.
Returns void
Method
Inherited from BaseCacheManager.expireBucket
- Defined in src/managers/BaseCacheManager.ts:175

fetch

fetch(userId: string): Promise<User>
Fetches a particular user.
Parameters
- userId: string
  The id of the user to fetch.
Returns Promise<User>
The fetched user.

Async
Method
Throws
Implementation of UserManagerType.fetch
- Defined in src/managers/UserManager.ts:55

fetchFromRules

fetchFromRules(key: string): Promise<null | User>
Fetches a value from the rules cache.
Parameters
- key: string
  The key to fetch.
Returns Promise<null | User>
The fetched value.

Method
Throws
Async
Implementation of UserManagerType.fetchFromRules
Overrides BaseCacheManager.fetchFromRules
- Defined in src/managers/UserManager.ts:38

fetchWithRules

fetchWithRules(key: string): Promise<null | User>
Fetches a value from the cache or from the rules cache.
Parameters
- key: string
  The key to fetch.
Returns Promise<null | User>
The fetched value.

Method
Async
Throws
Implementation of UserManagerType.fetchWithRules
Overrides BaseCacheManager.fetchWithRules
- Defined in src/managers/UserManager.ts:42

flagForDeletion

flagForDeletion(key: string): null | User
Parameters
- key: string
Returns null | User
Implementation of UserManagerType.flagForDeletion
Inherited from BaseCacheManager.flagForDeletion
- Defined in src/managers/BaseCacheManager.ts:228

forEach

forEach(callbackfn: unknown): void
Calls a function on each item in the cache.
Parameters
- callbackfn: unknown
Returns void
Method
Implementation of UserManagerType.forEach
Inherited from BaseCacheManager.forEach
- Defined in src/managers/BaseCacheManager.ts:314

get

get(id: string): null | User
Gets a value from the cache.
Parameters
- id: string
Returns null | User
The value from the cache.

Method
Throws
Implementation of UserManagerType.get
Overrides BaseCacheManager.get
- Defined in src/managers/UserManager.ts:75

has

has(key: string): boolean
Checks if a key exists in the cache.
Parameters
- key: string
  The key to check.
Returns boolean
Whether the key exists or not.

Method
Throws
Implementation of UserManagerType.has
Inherited from BaseCacheManager.has
- Defined in src/managers/BaseCacheManager.ts:328

map

map(
    callbackfn: (
        value: [string, User],
        index: number,
        array: [string, User][],
    ) => unknown,
): User[]
Parameters
- callbackfn: (value: [string, User], index: number, array: [string, User][]) => unknown
Returns User[]
Implementation of UserManagerType.map
Inherited from BaseCacheManager.map
- Defined in src/managers/BaseCacheManager.ts:332

set

set(id: string, user: User): void
Adds a user to the cache.
Parameters
- id: string
  The ID of the user to cache.
- user: User
  The user to cache.
Returns void
Method
Throws
Implementation of UserManagerType.set
Overrides BaseCacheManager.set
- Defined in src/managers/UserManager.ts:69

toJSON

toJSON(format?: JsonTypes): any[]
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns any[]
Method
Implementation of UserManagerType.toJSON
Inherited from BaseCacheManager.toJSON
- Defined in src/managers/BaseCacheManager.ts:350

`Static`fetchUser

fetchUser(client: Client, userId: string): Promise<User>
Parameters
- client: Client
- userId: string
Returns Promise<User>
- Defined in src/managers/UserManager.ts:79