Class UserManager

Manages API methods for users and stores their cache.

Hierarchy (View Summary)

CachedManager<Id, APIUser, User>
- UserManager

Index

Constructors

Properties

cache client holds

Methods

_add _remove createHeld fetch

Constructors

constructor

new UserManager(client: Client): UserManager
Parameters
- client: Client
Returns UserManager
Overrides CachedManager.constructor
- Defined in packages/foxochat.js/src/managers/UserManager/UserManager.ts:11

Properties

`Readonly`cache

cache: Map<number, User> = ...

The cache of items for this manager.

`Readonly`client

client: Client

The client that instantiated this Manager.

`Protected` `Readonly`holds

holds: Newable<User>

The data structure belonging to this manager.

Methods

_add

_add(key: number, data: APIUser): User
Adds an entry to the cache or updates an existing one.
Parameters
- key: number
- data: APIUser
Returns User
Inherited from CachedManager._add
- Defined in packages/foxochat.js/src/managers/CachedManager.ts:29

_remove

_remove(key: number): boolean
Removes an entry from the cache.
Parameters
- key: number
Returns boolean
Inherited from CachedManager._remove
- Defined in packages/foxochat.js/src/managers/CachedManager.ts:46

`Protected`createHeld

createHeld(data: APIUser): User
Parameters
- data: APIUser
Returns User
Inherited from CachedManager.createHeld
- Defined in packages/foxochat.js/src/managers/CachedManager.ts:50

fetch

fetch(key: "@me"): Promise<ClientUser>
Obtains a user from API, or the user cache if it's already available.
Parameters
- key: "@me"
Returns Promise<ClientUser>
- Defined in packages/foxochat.js/src/managers/UserManager/UserManager.ts:18
fetch(key: PublicUserKey): Promise<User>
Obtains a user from API, or the user cache if it's already available.
Parameters
- key: PublicUserKey
Returns Promise<User>
- Defined in packages/foxochat.js/src/managers/UserManager/UserManager.ts:19
fetch(options: FetchUserOptions): Promise<User>
Obtains a user from API, or the user cache if it's already available.
Parameters
- options: FetchUserOptions
Returns Promise<User>
- Defined in packages/foxochat.js/src/managers/UserManager/UserManager.ts:20