Class GenericRedisCacher<TFields, TIDField>

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof TFields

Implements

IEntityGenericCacher<TFields, TIDField>

Index

Constructors

Methods

cacheDBMissesAsync cacheManyAsync invalidateManyAsync loadManyAsync makeCacheKeyForStorage makeCacheKeysForInvalidation

Constructors

constructor

new GenericRedisCacher<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    context: GenericRedisCacheContext,
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
): GenericRedisCacher<TFields, TIDField>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- context: GenericRedisCacheContext
- entityConfiguration: EntityConfiguration<TFields, TIDField>
Returns GenericRedisCacher<TFields, TIDField>
- Defined in GenericRedisCacher.ts:119

Methods

cacheDBMissesAsync

cacheDBMissesAsync(keys: readonly string[]): 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>
Implementation of IEntityGenericCacher.cacheDBMissesAsync
- Defined in GenericRedisCacher.ts:181

cacheManyAsync

cacheManyAsync(objectMap: ReadonlyMap<string, Readonly<TFields>>): 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>
Implementation of IEntityGenericCacher.cacheManyAsync
- Defined in GenericRedisCacher.ts:162

invalidateManyAsync

invalidateManyAsync(keys: readonly string[]): 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>
Implementation of IEntityGenericCacher.invalidateManyAsync
- Defined in GenericRedisCacher.ts:198

loadManyAsync

loadManyAsync(
keys: readonly string[],
): 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>>>
Implementation of IEntityGenericCacher.loadManyAsync
- Defined in GenericRedisCacher.ts:124

makeCacheKeyForStorage

makeCacheKeyForStorage<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    value: TLoadValue,
): string
Create a cache key for a load key and load value of an object being cached (or negatively cached).
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key of the cache key
- value: TLoadValue
  load value of the cache key
Returns string
Implementation of IEntityGenericCacher.makeCacheKeyForStorage
- Defined in GenericRedisCacher.ts:222

makeCacheKeysForInvalidation

makeCacheKeysForInvalidation<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    value: TLoadValue,
): readonly string[]
Create a cache key for a load key and load values of an object being invalidated. This is separate from makeCacheKeyForStorage because invalidation can optionally be configured to invalidate a larger set of keys than the one for just the current cache version, which can be useful for things like push safety.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key for the cache keys
- value: TLoadValue
  load value for the cache keys
Returns readonly string[]
Implementation of IEntityGenericCacher.makeCacheKeysForInvalidation
- Defined in GenericRedisCacher.ts:234