Class ReadThroughEntityCache<TFields, TIDField>

A read-through entity cache is responsible for coordinating EntityDatabaseAdapter and EntityCacheAdapter within the EntityDataManager.

Type Parameters

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

Index

Constructors

constructor

Methods

invalidateManyAsync readManyThroughAsync

Constructors

constructor

new ReadThroughEntityCache<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
    entityCacheAdapter: IEntityCacheAdapter<TFields, TIDField>,
): ReadThroughEntityCache<TFields, TIDField>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
- entityCacheAdapter: IEntityCacheAdapter<TFields, TIDField>
Returns ReadThroughEntityCache<TFields, TIDField>
- Defined in packages/entity/src/internal/ReadThroughEntityCache.ts:34

Methods

invalidateManyAsync

invalidateManyAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    values: readonly TLoadValue[],
): Promise<void>
Invalidate the cache for objects cached by (key, value).
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key to be invalidated
- values: readonly TLoadValue[]
  load values to be invalidated for key
Returns Promise<void>
- Defined in packages/entity/src/internal/ReadThroughEntityCache.ts:145

readManyThroughAsync

readManyThroughAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    values: readonly TLoadValue[],
    fetcher: (
        fetcherValues: readonly TLoadValue[],
    ) => Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>,
): Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>
Read-through cache function. Steps:
1. Check for cached (key, value) objects
2. Query the fetcher for values not in the cache
3. Cache the results from the fetcher
4. Negatively cache anything missing from the fetcher
5. Return the full set of data for the query.
If cache is not applicable for key, return results from fetcher.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key being queried
- values: readonly TLoadValue[]
  load values being queried
- fetcher: (
  fetcherValues: readonly TLoadValue[],
  ) => Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>
  closure used to provide underlying data source objects for key and fetcherValues
Returns Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>
map from value to objects that match the query for that value
- Defined in packages/entity/src/internal/ReadThroughEntityCache.ts:63

Class ReadThroughEntityCache<TFields, TIDField>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ReadThroughEntityCache<TFields, TIDField>

Methods

invalidateManyAsync

Type Parameters

Parameters

Returns Promise<void>

readManyThroughAsync

Type Parameters

Parameters

Returns Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>

Settings

On This Page