Class AresCachedManager<Key, Value>`Abstract`

Abstract class that serves as the foundation for managing cached data. Inherits basic manager functionalities and introduces caching capabilities.

Type Parameters

Key
The type of keys used for caching.
Value
The type of values associated with the cached keys.

Hierarchy

AresBaseManager
- AresCachedManager
  - AresCommandsManager
  - AresEventsManager

Index

Constructors

Properties

results cache scope client

Accessors

Methods

checkGenericConditions checkSpecificConditions? isValidValue add delete setup init

Constructors

constructor

new AresCachedManager<Key, Value>(client, scope): AresCachedManager<Key, Value>
Type Parameters
- Key
- Value
Parameters
- client: AresClient
- scope: LogScopes
Returns AresCachedManager<Key, Value>
Overrides AresBaseManager.constructor
- Defined in src/lib/classes/cachedManager.ts:32

Properties

`Protected` `Readonly` results

results: AresCachedResults = ...

Results instance associated with the manager.

`Readonly` cache

cache: Collection<Key, Value>

The collection of cached items.

`Protected` `Readonly` scope

scope: LogScopes

Represents the scope of the logger, enabling categorization and filtering of log entries.

`Readonly` client

client: AresClient

Represents the client that instantiated this class.

Accessors

`Protected` isProduction

get isProduction(): boolean
Indicates whether the application is running in production mode.

Returns boolean
true if the application is running in production mode; otherwise, false.
Inherited from AresBaseManager.isProduction
- Defined in src/lib/classes/base.ts:14

Methods

`Private` checkGenericConditions

checkGenericConditions(key, value): boolean
Validates whether the entry meets the generic conditions for the manager cache.
Parameters
- key: Key
  The key to validate.
- value: Value
  The value to validate.
Returns boolean
true if the entry meets the generic conditions for the manager cache; otherwise false.
- Defined in src/lib/classes/cachedManager.ts:44

`Protected` `Optional` checkSpecificConditions

checkSpecificConditions(key, value): boolean
Validates whether the entry meets the specific conditions for the manager cache.
Parameters
- key: Key
- value: Value
  The value to validate.
Returns boolean
true if the entry meets the specific conditions for the manager cache; otherwise false.

Remarks
Method used in further entry validation, checking for specific conditions based on the entry type.
- Defined in src/lib/classes/cachedManager.ts:67

`Private` isValidValue

isValidValue(key, value): boolean
Validates whether the value meets the conditions for the manager cache.
Parameters
- key: Key
- value: Value
  The value to validate.
Returns boolean
- Defined in src/lib/classes/cachedManager.ts:73

add

add(key, value): void
Adds a new entry to the cache.
Parameters
- key: Key
  The key to add.
- value: Value
  The value to add.
Returns void
- Defined in src/lib/classes/cachedManager.ts:91

delete

delete(key): void
Deletes an entry from the cache.
Parameters
- key: Key
  The key to delete.
Returns void
- Defined in src/lib/classes/cachedManager.ts:104

`Protected` `Abstract` setup

setup(opts): Awaitable<void>
Sets up the manager by supplying essential data and performing preparatory tasks.
Parameters
- opts: AresManagerOptions
Returns Awaitable<void>
Remarks
Orchestrates the initialization process, encompassing the setup of foundational data and execution of preparatory tasks. This ensures that the manager is equipped to handle interactions and various operations effectively.
Inherited from AresBaseManager.setup
- Defined in src/lib/classes/baseManager.ts:34

init

init(opts): Promise<void>
Sealed
Initializes the manager.
Parameters
- opts: AresManagerOptions
Returns Promise<void>
Remarks
This method should be called after creating an instance of the class to perform any necessary setup or initialization.
Inherited from AresBaseManager.init
- Defined in src/lib/classes/baseManager.ts:44

Generated using TypeDoc