Class CacheLoader<K, V>`Abstract`

Cache class allowing to create caches with automatic cache loading and delegates.

Type Parameters

K extends Object
V extends Object

Hierarchy

BaseCacheLoader<K, V>
- CacheLoader

Index

Constructors

Properties

Methods

addMetadata delete deserialize exists get getCacheDefinition getCacheId getWithMetadata keyToString load reset serialize set

Constructors

`Protected` constructor

new CacheLoader<K, V>(cacheId, options?): CacheLoader<K, V>
Constructor.
Type Parameters
- K extends Object
- V extends Object
Parameters
- cacheId: string
  
  the identifier of the cache
- options: CacheOptions = {}
  
  the cache options:
Returns CacheLoader<K, V>
Overrides BaseCacheLoader<K, V>.constructor
- Defined in CacheLoader.ts:15

Properties

`Protected` isCacheable

isCacheable: boolean

Methods

`Protected` addMetadata

addMetadata(metadata): void
Parameters
- metadata: CacheMetadata
Returns void
Inherited from BaseCacheLoader.addMetadata
- Defined in BaseCacheLoader.ts:241

delete

delete(key): Promise<void>
Deletes a cache entry for a given key.
Parameters
- key: K
Returns Promise<void>
Inherited from BaseCacheLoader.delete
- Defined in BaseCacheLoader.ts:175

`Protected` deserialize

deserialize(value): V
Parameters
- value: any
Returns V
Inherited from BaseCacheLoader.deserialize
- Defined in BaseCacheLoader.ts:230

exists

exists(key): Promise<boolean>
Checks if a cache entry exists for a given key.
Parameters
- key: K
Returns Promise<boolean>
true if the entry exists in the cache, false otherwise
Inherited from BaseCacheLoader.exists
- Defined in BaseCacheLoader.ts:160

get

get(key, force?): Promise<V>
Gets a cached value.
Parameters
- key: K
  
  the cache key
- force: boolean = false
  
  whether to force the cache refresh for that key (default: false)
Returns Promise<V>
the cached value
Inherited from BaseCacheLoader.get
- Defined in BaseCacheLoader.ts:76

getCacheDefinition

getCacheDefinition(): CacheDefinition
Returns CacheDefinition
Inherited from BaseCacheLoader.getCacheDefinition
- Defined in BaseCacheLoader.ts:203

getCacheId

getCacheId(): string
Returns string
Inherited from BaseCacheLoader.getCacheId
- Defined in BaseCacheLoader.ts:199

getWithMetadata

getWithMetadata(key, force?): Promise<Metadata<V>>
Gets a cached value with additional metadata.
Parameters
- key: K
  
  the cache key
- force: boolean = false
  
  whether to force the cache refresh for that key (default: false)
Returns Promise<Metadata<V>>
the cached value
Inherited from BaseCacheLoader.getWithMetadata
- Defined in BaseCacheLoader.ts:109

`Protected` keyToString

keyToString(key): string
Parameters
- key: K
Returns string
Inherited from BaseCacheLoader.keyToString
- Defined in BaseCacheLoader.ts:207

`Protected` `Abstract` load

load(key): Promise<V>
Parameters
- key: K
Returns Promise<V>
Inherited from BaseCacheLoader.load
- Defined in BaseCacheLoader.ts:67

reset

reset(): Promise<void>
Deletes all entries in the cache;

Returns Promise<void>
Inherited from BaseCacheLoader.reset
- Defined in BaseCacheLoader.ts:189

`Protected` serialize

serialize(value): any
Parameters
- value: V
Returns any
Inherited from BaseCacheLoader.serialize
- Defined in BaseCacheLoader.ts:219

set

set(key, value): Promise<void>
Parameters
- key: K
- value: V
Returns Promise<void>
Inherited from BaseCacheLoader.set
- Defined in BaseCacheLoader.ts:138

Generated using TypeDoc