Class MemberManager

Manages API methods for members and stores their cache.

Hierarchy (View Summary)

CachedManager<Id, APIMember, Member>
- MemberManager

Index

Constructors

Properties

cache client holds

Methods

_add _remove createHeld fetch

Constructors

constructor

new MemberManager(channel: Channel): MemberManager
Parameters
- channel: Channel
Returns MemberManager
Overrides CachedManager.constructor
- Defined in packages/foxochat.js/src/managers/MemberManager/MemberManager.ts:10

Properties

`Readonly`cache

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

The cache of items for this manager.

`Readonly`client

client: Client

The client that instantiated this Manager.

`Protected` `Readonly`holds

holds: Newable<Member>

The data structure belonging to this manager.

Methods

_add

_add(key: number, data: APIMember): Member
Adds an entry to the cache or updates an existing one.
Parameters
- key: number
- data: APIMember
Returns Member
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: APIMember): Member
Parameters
- data: APIMember
Returns Member
Inherited from CachedManager.createHeld
- Defined in packages/foxochat.js/src/managers/CachedManager.ts:50

fetch

fetch(id: number): Promise<Member>
Obtains a member from API, or the member cache if it's already available.
Parameters
- id: number
Returns Promise<Member>
- Defined in packages/foxochat.js/src/managers/MemberManager/MemberManager.ts:17
fetch(options: FetchMemberOptions): Promise<Member>
Obtains a member from API, or the member cache if it's already available.
Parameters
- options: FetchMemberOptions
Returns Promise<Member>
- Defined in packages/foxochat.js/src/managers/MemberManager/MemberManager.ts:18
fetch(options?: FetchMembersOptions): Promise<Map<number, Member>>
Obtains a member from API, or the member cache if it's already available.
Parameters
- Optionaloptions: FetchMembersOptions
Returns Promise<Map<number, Member>>
- Defined in packages/foxochat.js/src/managers/MemberManager/MemberManager.ts:19