Interface IEntityCacheAdapter<TFields, TIDField>

A cache adapter is an interface by which objects can be cached, fetched from cache, and removed from cache (invalidated).

interface IEntityCacheAdapter<
    TFields extends Record<string, any>,
    TIDField extends keyof TFields,
> {
    cacheDBMissesAsync<
        TLoadKey extends
            IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
        TSerializedLoadValue,
        TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
    >(
        key: TLoadKey,
        values: readonly TLoadValue[],
    ): Promise<void>;
    cacheManyAsync<
        TLoadKey extends
            IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
        TSerializedLoadValue,
        TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
    >(
        key: TLoadKey,
        objectMap: ReadonlyMap<TLoadValue, Readonly<TFields>>,
    ): Promise<void>;
    invalidateManyAsync<
        TLoadKey extends
            IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
        TSerializedLoadValue,
        TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
    >(
        key: TLoadKey,
        values: readonly TLoadValue[],
    ): Promise<void>;
    loadManyAsync<
        TLoadKey extends
            IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
        TSerializedLoadValue,
        TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
    >(
        key: TLoadKey,
        values: readonly TLoadValue[],
    ): Promise<ReadonlyMap<TLoadValue, CacheLoadResult<TFields>>>;
}

Type Parameters

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

Implemented by

Index

Methods

cacheDBMissesAsync cacheManyAsync invalidateManyAsync loadManyAsync

Methods

cacheDBMissesAsync

cacheDBMissesAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    values: readonly TLoadValue[],
): Promise<void>
Negatively cache objects that could not be found in the cache or DB.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key to cache misses for
- values: readonly TLoadValue[]
  load values for objects reported as CacheStatus.NEGATIVE in the cache and not found in the DB.
Returns Promise<void>
- Defined in packages/entity/src/IEntityCacheAdapter.ts:47

cacheManyAsync

cacheManyAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    objectMap: ReadonlyMap<TLoadValue, Readonly<TFields>>,
): Promise<void>
Cache many objects fetched from the DB.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key to cache
- objectMap: ReadonlyMap<TLoadValue, Readonly<TFields>>
  map from load value to object to cache for the key
Returns Promise<void>
- Defined in packages/entity/src/IEntityCacheAdapter.ts:32

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 invalidate
- values: readonly TLoadValue[]
  load values to be invalidated for the key
Returns Promise<void>
- Defined in packages/entity/src/IEntityCacheAdapter.ts:61

loadManyAsync

loadManyAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    key: TLoadKey,
    values: readonly TLoadValue[],
): Promise<ReadonlyMap<TLoadValue, CacheLoadResult<TFields>>>
Load many objects from cache.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- key: TLoadKey
  load key to load
- values: readonly TLoadValue[]
  load values to load for the key
Returns Promise<ReadonlyMap<TLoadValue, CacheLoadResult<TFields>>>
map from all load values to a CacheLoadResult for that value
- Defined in packages/entity/src/IEntityCacheAdapter.ts:18