Class RedisSecondaryEntityCache<TFields, TIDField, TLoadParams>

A redis GenericSecondaryEntityCache.

Type Parameters

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

Hierarchy (View Summary, Expand)

GenericSecondaryEntityCache<TFields, TIDField, TLoadParams>
- RedisSecondaryEntityCache

Index

Constructors

Methods

invalidateManyAsync loadManyThroughAsync

Constructors

constructor

new RedisSecondaryEntityCache<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TLoadParams,
>(
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
    genericRedisCacheContext: GenericRedisCacheContext,
    constructRedisKey: (params: Readonly<TLoadParams>) => string,
): RedisSecondaryEntityCache<TFields, TIDField, TLoadParams>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TLoadParams
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
- genericRedisCacheContext: GenericRedisCacheContext
- constructRedisKey: (params: Readonly<TLoadParams>) => string
Returns RedisSecondaryEntityCache<TFields, TIDField, TLoadParams>
Overrides GenericSecondaryEntityCache.constructor
- Defined in entity-secondary-cache-redis/src/RedisSecondaryEntityCache.ts:12

Properties

`Protected` `Readonly`cacher

cacher: IEntityGenericCacher<TFields, TIDField>

`Protected` `Readonly`constructCacheKey

constructCacheKey: (params: Readonly<TLoadParams>) => string

Methods

invalidateManyAsync

invalidateManyAsync(
loadParamsArray: readonly Readonly<TLoadParams>[],
): Promise<void>
Invalidate the cache for objects cached by constructCacheKey(loadParams).
Parameters
- loadParamsArray: readonly Readonly<TLoadParams>[]
  load params to invalidate
Returns Promise<void>
Inherited from GenericSecondaryEntityCache.invalidateManyAsync
- Defined in entity/build/GenericSecondaryEntityCache.d.ts:18

loadManyThroughAsync

loadManyThroughAsync(
    loadParamsArray: readonly Readonly<TLoadParams>[],
    fetcher: (
        fetcherLoadParamsArray: readonly Readonly<TLoadParams>[],
    ) => Promise<ReadonlyMap<Readonly<TLoadParams>, null | Readonly<TFields>>>,
): Promise<ReadonlyMap<Readonly<TLoadParams>, null | Readonly<TFields>>>
Read-through cache function.
Parameters
- loadParamsArray: readonly Readonly<TLoadParams>[]
  array of loadParams to load from the cache
- fetcher: (
  fetcherLoadParamsArray: readonly Readonly<TLoadParams>[],
  ) => Promise<ReadonlyMap<Readonly<TLoadParams>, null | Readonly<TFields>>>
  closure used to provide underlying data source objects for loadParams
Returns Promise<ReadonlyMap<Readonly<TLoadParams>, null | Readonly<TFields>>>
map from loadParams to the entity field object
Inherited from GenericSecondaryEntityCache.loadManyThroughAsync
- Defined in entity/build/GenericSecondaryEntityCache.d.ts:12