Class GuildChannelsManager

Manages all channels within a guild.

Hierarchy (View Summary)

BaseCacheManager<AllChannels>
- GuildChannelsManager

Implements

GuildChannelsManager

Index

Constructors

constructor

new GuildChannelsManager(client: Client, guild: Guild): GuildChannelsManager
Creates a guild channel manager.
Parameters
- client: Client
  The client instance.
- guild: Guild
  The guild that this channel manager belongs to.
Returns GuildChannelsManager
Overrides BaseCacheManager.constructor
- Defined in src/managers/GuildChannelsManager.ts:28

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 GuildChannelsManagerType.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 GuildChannelsManagerType._intervalCallback
Inherited from BaseCacheManager._intervalCallback
- Defined in src/managers/BaseCacheManager.ts:251

#_callFetches

"#_callFetches"(id: string): Promise<null | AllChannels>
Calls all the custom fetches.
Parameters
- id: string
  The ID to fetch.
Returns Promise<null | AllChannels>
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 GuildChannelsManagerType.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 GuildChannelsManagerType.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(channel_id: string): Promise<AllChannels>
Fetches a particular channel belonging to this guild.
Parameters
- channel_id: string
  The id of the channel to fetch.
Returns Promise<AllChannels>
The fetched channel.

Async
Method
Throws
Implementation of GuildChannelsManagerType.fetch
- Defined in src/managers/GuildChannelsManager.ts:80

fetchFromRules

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

Method
Throws
Async
Implementation of GuildChannelsManagerType.fetchFromRules
Overrides BaseCacheManager.fetchFromRules
- Defined in src/managers/GuildChannelsManager.ts:63

fetchWithRules

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

Method
Async
Throws
Implementation of GuildChannelsManagerType.fetchWithRules
Overrides BaseCacheManager.fetchWithRules
- Defined in src/managers/GuildChannelsManager.ts:67

flagForDeletion

flagForDeletion(key: string): null | NonNullable<AllChannels>
Parameters
- key: string
Returns null | NonNullable<AllChannels>
Implementation of GuildChannelsManagerType.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 GuildChannelsManagerType.forEach
Inherited from BaseCacheManager.forEach
- Defined in src/managers/BaseCacheManager.ts:314

get

get(id: string): null | AllChannels
Gets a channel from the cache.
Parameters
- id: string
  The ID of the channel to get.
Returns null | AllChannels
Method
Implementation of GuildChannelsManagerType.get
Overrides BaseCacheManager.get
- Defined in src/managers/GuildChannelsManager.ts:59

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 GuildChannelsManagerType.has
Inherited from BaseCacheManager.has
- Defined in src/managers/BaseCacheManager.ts:328

map

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

set

set(id: string, channel: AllChannels, expiry?: number): void
Adds a channel to the cache.
Parameters
- id: string
  The ID of the channel to cache.
- channel: AllChannels
  The channel to cache.
- Optionalexpiry: number
Returns void
Method
Throws
Implementation of GuildChannelsManagerType.set
Overrides BaseCacheManager.set
- Defined in src/managers/GuildChannelsManager.ts:104

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 GuildChannelsManagerType.toJSON
Inherited from BaseCacheManager.toJSON
- Defined in src/managers/BaseCacheManager.ts:350

`Static`fetchChannel

fetchChannel(
    client: Client,
    guildId: string,
    channelId: string,
): Promise<AllChannels>
Parameters
- client: Client
- guildId: string
- channelId: string
Returns Promise<AllChannels>
- Defined in src/managers/GuildChannelsManager.ts:141

`Static`getCacheManager

getCacheManager(client: Client, guildId: string): GuildChannelsManager
Parameters
- client: Client
- guildId: string
Returns GuildChannelsManager
- Defined in src/managers/GuildChannelsManager.ts:126

`Static`getChannel

getChannel(
    client: Client,
    guildId: string,
    channelId: string,
): null | AllChannels
Parameters
- client: Client
- guildId: string
- channelId: string
Returns null | AllChannels
- Defined in src/managers/GuildChannelsManager.ts:108

Class GuildChannelsManager

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GuildChannelsManager

Properties

Staticidentifier

Staticrules

Accessors

size

Returns number

Methods

_intervalCallback

Returns { i: StructureIdentifiers }

Method

#_callFetches

Parameters

Returns Promise<null | AllChannels>

Method

Async

#_callRules

Parameters

Returns void

Method

#addToExpiryBucket

Parameters

Returns void

Method

#clearStaleBuckets

Returns void

Method

clear

Returns void

Method

delete

Parameters

Returns boolean

Method

expireBucket

Parameters

Returns void

Method

fetch

Parameters

Returns Promise<AllChannels>

Async

Method

Throws

fetchFromRules

Parameters

Returns Promise<null | AllChannels>

Method

Throws

Async

fetchWithRules

Parameters

Returns Promise<null | AllChannels>

Method

Async

Throws

flagForDeletion

Parameters

Returns null | NonNullable<AllChannels>

forEach

Parameters

Returns void

Method

get

Parameters

Returns null | AllChannels

Method

has

Parameters

`Static`identifier

`Static`rules

`Static`fetchChannel

`Static`getCacheManager

`Static`getChannel