Class GuildRoleManager

Manages all roles belonging to a guild.

Hierarchy (View Summary)

BaseCacheManager<RoleType>
- GuildRoleManager

Implements

GuildRoleManager

Index

Constructors

Properties

identifier rules

Accessors

Constructors

constructor

new GuildRoleManager(client: Client, guild: Guild): GuildRoleManager
Creates a role manager.
Parameters
- client: Client
  The client instance.
- guild: Guild
  The guild that this role manager belongs to.
Returns GuildRoleManager
Overrides BaseCacheManager.constructor
- Defined in src/managers/GuildRoleManager.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 GuildRoleManagerType.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 GuildRoleManagerType._intervalCallback
Inherited from BaseCacheManager._intervalCallback
- Defined in src/managers/BaseCacheManager.ts:251

#_callFetches

"#_callFetches"(id: string): Promise<null | Role>
Calls all the custom fetches.
Parameters
- id: string
  The ID to fetch.
Returns Promise<null | Role>
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 GuildRoleManagerType.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 GuildRoleManagerType.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(roleId: string): Promise<Role | Role>
Parameters
- roleId: string
Returns Promise<Role | Role>
Implementation of GuildRoleManagerType.fetch
- Defined in src/managers/GuildRoleManager.ts:59

fetchFromRules

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

Method
Throws
Async
Implementation of GuildRoleManagerType.fetchFromRules
Overrides BaseCacheManager.fetchFromRules
- Defined in src/managers/GuildRoleManager.ts:51

fetchWithRules

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

Method
Async
Throws
Implementation of GuildRoleManagerType.fetchWithRules
Overrides BaseCacheManager.fetchWithRules
- Defined in src/managers/GuildRoleManager.ts:55

flagForDeletion

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

get

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

Method
Throws
Implementation of GuildRoleManagerType.get
Overrides BaseCacheManager.get
- Defined in src/managers/GuildRoleManager.ts:90

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

map

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

set

set(id: string, role: Role): void
Sets a value in the cache.
Parameters
- id: string
- role: Role
Returns void
The value that was set.

Method
Throws
Implementation of GuildRoleManagerType.set
Overrides BaseCacheManager.set
- Defined in src/managers/GuildRoleManager.ts:84

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

`Static`fetchRole

fetchRole(
    client: Client,
    guildId: string,
    roleId: string,
): Promise<Role | Role[]>
Parameters
- client: Client
- guildId: string
- roleId: string
Returns Promise<Role | Role[]>
- Defined in src/managers/GuildRoleManager.ts:130

`Static`getCacheManager

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

`Static`getRole

getRole(client: Client, guildId: string, roleId: string): null | Role
Parameters
- client: Client
- guildId: string
- roleId: string
Returns null | Role
- Defined in src/managers/GuildRoleManager.ts:94