Interface ILocalMemoryCache<TFields>

Interface for a local memory cache used by GenericLocalMemoryCacher. Most often, this is something like a TTLCache from the @isaacs/ttlcache package or an lru-cache.

interface ILocalMemoryCache<TFields extends Record<string, any>> {
    delete(key: string): void;
    get(key: string): LocalMemoryCacheValue<TFields> | undefined;
    set(key: string, value: LocalMemoryCacheValue<TFields>): void;
}

Type Parameters

TFields extends Record<string, any>

Index

Methods

Methods

delete

delete(key: string): void
Deletes a value from the cache for specified key.
Parameters
- key: string
  key to delete
Returns void
- Defined in GenericLocalMemoryCacher.ts:45

get

get(key: string): LocalMemoryCacheValue<TFields> | undefined
Gets a value from the cache for specified key.
Parameters
- key: string
  key to get
Returns LocalMemoryCacheValue<TFields> | undefined
the cached value, or undefined if not present
- Defined in GenericLocalMemoryCacher.ts:32

set

set(key: string, value: LocalMemoryCacheValue<TFields>): void
Sets a value in the cache for specified key.
Parameters
- key: string
  key to set
- value: LocalMemoryCacheValue<TFields>
  value to set
Returns void
- Defined in GenericLocalMemoryCacher.ts:39