Interface IEntityGenericCacher<TFields>

A generic cacher stores and loads key-value pairs. It also supports negative caching - it stores the absence of keys that don't exist in the backing datastore. It is also responsible for cache key creation.

Type Parameters

TFields

Hierarchy

IEntityGenericCacher

Index

Methods

cacheDBMissesAsync cacheManyAsync invalidateManyAsync loadManyAsync makeCacheKey

Methods

cacheDBMissesAsync

cacheDBMissesAsync(keys): Promise<void>
Negatively-cache specified keys. Subsequent loads for these keys (without calling invalidate) may return a negative CacheLoadResult
Parameters
- keys: readonly string[]
  
  keys to cache negatively
Returns Promise<void>
- Defined in packages/entity/src/IEntityGenericCacher.ts:29

cacheManyAsync

cacheManyAsync(objectMap): Promise<void>
Cache many objects for specified keys.
Parameters
- objectMap: ReadonlyMap<string, Readonly<TFields>>
  
  map from cache key to object to cache for key
Returns Promise<void>
- Defined in packages/entity/src/IEntityGenericCacher.ts:21

invalidateManyAsync

invalidateManyAsync(keys): Promise<void>
Invalidate specified keys in cache. Subsequent loads for these keys may return a cache miss.
Parameters
- keys: readonly string[]
  
  keys to invalidate
Returns Promise<void>
- Defined in packages/entity/src/IEntityGenericCacher.ts:36

loadManyAsync

loadManyAsync(keys): Promise<ReadonlyMap<string, CacheLoadResult<TFields>>>
Load many keys from the cache. Return info in a format that is useful for read-through caching and negative caching.
Parameters
- keys: readonly string[]
  
  cache keys to load
Returns Promise<ReadonlyMap<string, CacheLoadResult<TFields>>>
- Defined in packages/entity/src/IEntityGenericCacher.ts:14

makeCacheKey

makeCacheKey<N>(fieldName, fieldValue): string
Create a cache key for a field and value of a object being cached or invalidated.
Type Parameters
- N extends string | number | symbol
Parameters
- fieldName: N
  
  name of the object field for this cache key
- fieldValue: NonNullable<TFields[N]>
  
  value of the obejct field for this cache key
Returns string
- Defined in packages/entity/src/IEntityGenericCacher.ts:44

Generated using TypeDoc