Class ChannelManager

Manages API methods for channels and stores their cache.

Hierarchy (View Summary)

CachedManager<Id, APIChannel, Channel>
- ChannelManager

Index

Constructors

Properties

cache client holds

Methods

_add _remove createHeld fetch

Constructors

constructor

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

Properties

`Readonly`cache

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

The cache of items for this manager.

`Readonly`client

client: Client

The client that instantiated this Manager.

`Protected` `Readonly`holds

holds: Newable<Channel>

The data structure belonging to this manager.

Methods

_add

_add(key: number, data: APIChannel): Channel
Adds an entry to the cache or updates an existing one.
Parameters
- key: number
- data: APIChannel
Returns Channel
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
Overrides CachedManager._remove
- Defined in packages/foxochat.js/src/managers/ChannelManager/ChannelManager.ts:33

`Protected`createHeld

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

fetch

fetch(key: PublicChannelKey): Promise<Channel>
Obtains a channel from API, or the channel cache if it's already available.
Parameters
- key: PublicChannelKey
Returns Promise<Channel>
- Defined in packages/foxochat.js/src/managers/ChannelManager/ChannelManager.ts:18
fetch(options: FetchChannelOptions): Promise<Channel>
Obtains a channel from API, or the channel cache if it's already available.
Parameters
- options: FetchChannelOptions
Returns Promise<Channel>
- Defined in packages/foxochat.js/src/managers/ChannelManager/ChannelManager.ts:19