Class EntitySecondaryCacheLoader<TLoadParams, TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>`Abstract`

A secondary cache loader allows for arbitrary cache keying for load params, which are a set of params used to load a single entity field object.

Note that this cache cannot be automatically invalidated like other entity caches so it must be manually invalidated when the underlying data of a cache key could be stale.

This is most commonly used to further optimize hot paths that cannot make use of normal entity cache loading due to use of a non-unique-field-based EntityLoader method like loadManyByFieldEqualityConjunctionAsync or loadManyByRawWhereClauseAsync.

Type Parameters

TLoadParams
TFields extends Record<string, any>
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>
TViewerContext extends ViewerContext
TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
TSelectedFields extends keyof TFields = keyof TFields

Index

Constructors

constructor

Methods

fetchObjectsFromDatabaseAsync invalidateManyAsync loadManyAsync getConstructionUtilsForEntityClass

Constructors

constructor

new EntitySecondaryCacheLoader<
    TLoadParams,
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TViewerContext extends ViewerContext,
    TEntity extends
        ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TPrivacyPolicy extends
        EntityPrivacyPolicy<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >,
    TSelectedFields extends string
    | number
    | symbol = keyof TFields,
>(
    secondaryEntityCache: ISecondaryEntityCache<TFields, TLoadParams>,
    constructionUtils: EntityConstructionUtils<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
): EntitySecondaryCacheLoader<
    TLoadParams,
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Type Parameters
- TLoadParams
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol = keyof TFields
Parameters
- secondaryEntityCache: ISecondaryEntityCache<TFields, TLoadParams>
- constructionUtils: EntityConstructionUtils<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
Returns EntitySecondaryCacheLoader<
    TLoadParams,
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in packages/entity/src/EntitySecondaryCacheLoader.ts:63

Methods

`Protected` `Abstract`fetchObjectsFromDatabaseAsync

fetchObjectsFromDatabaseAsync(
loadParamsArray: readonly Readonly<TLoadParams>[],
): Promise<
ReadonlyMap<Readonly<Readonly<TLoadParams>>, Readonly<TFields> | null>,
>
Load through method called to fetch objects when load params objects are not in the cache
Parameters
- loadParamsArray: readonly Readonly<TLoadParams>[]
  array of load params objects to load
Returns Promise<ReadonlyMap<Readonly<Readonly<TLoadParams>>, Readonly<TFields> | null>>
- Defined in packages/entity/src/EntitySecondaryCacheLoader.ts:111

invalidateManyAsync

invalidateManyAsync(
loadParamsArray: readonly Readonly<TLoadParams>[],
): Promise<void>
Invalidate the cache for objects cached by loadParams.
Parameters
- loadParamsArray: readonly Readonly<TLoadParams>[]
  array of load params objects to invalidate
Returns Promise<void>
- Defined in packages/entity/src/EntitySecondaryCacheLoader.ts:100

loadManyAsync

loadManyAsync(
loadParamsArray: readonly Readonly<TLoadParams>[],
): Promise<ReadonlyMap<Readonly<TLoadParams>, Result<TEntity> | null>>
Load many by load params objects
Parameters
- loadParamsArray: readonly Readonly<TLoadParams>[]
  array of loadParams to load through the cache
Returns Promise<ReadonlyMap<Readonly<TLoadParams>, Result<TEntity> | null>>
- Defined in packages/entity/src/EntitySecondaryCacheLoader.ts:80

`Static`getConstructionUtilsForEntityClass

getConstructionUtilsForEntityClass<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TViewerContext extends ViewerContext,
    TEntity extends
        ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TPrivacyPolicy extends
        EntityPrivacyPolicy<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >,
    TSelectedFields extends string
    | number
    | symbol = keyof TFields,
>(
    entityClass: IEntityClass<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
    viewerContext: TViewerContext,
    queryContext?: EntityQueryContext,
): EntityConstructionUtils<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Helper to get construction utils for instantiating a EntitySecondaryCacheLoader.
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol = keyof TFields
Parameters
- entityClass: IEntityClass<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
  the entity class for which to get construction utils for
- viewerContext: TViewerContext
  the viewer context to use for construction utils
- queryContext: EntityQueryContext = ...
  query context to use for construction utils
Returns EntityConstructionUtils<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
construction utils for the given entity class and viewer context
- Defined in packages/entity/src/EntitySecondaryCacheLoader.ts:123

Class EntitySecondaryCacheLoader<TLoadParams, TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>`Abstract`

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EntitySecondaryCacheLoader<
    TLoadParams,
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>

Methods

`Protected` `Abstract`fetchObjectsFromDatabaseAsync

Parameters

Returns Promise<ReadonlyMap<Readonly<Readonly<TLoadParams>>, Readonly<TFields> | null>>

invalidateManyAsync

Parameters

Returns Promise<void>

loadManyAsync

Parameters

Returns Promise<ReadonlyMap<Readonly<TLoadParams>, Result<TEntity> | null>>

`Static`getConstructionUtilsForEntityClass

Type Parameters

Parameters

Returns EntityConstructionUtils<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>

Settings

On This Page

Class EntitySecondaryCacheLoader<TLoadParams, TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>Abstract

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EntitySecondaryCacheLoader< TLoadParams, TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields,>

Methods

Protected AbstractfetchObjectsFromDatabaseAsync

Parameters

Returns Promise<ReadonlyMap<Readonly<Readonly<TLoadParams>>, Readonly<TFields> | null>>

invalidateManyAsync

Parameters

Returns Promise<void>

loadManyAsync

Parameters

Returns Promise<ReadonlyMap<Readonly<TLoadParams>, Result<TEntity> | null>>

StaticgetConstructionUtilsForEntityClass

Type Parameters

Parameters

Returns EntityConstructionUtils< TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields,>

Settings

On This Page

Class EntitySecondaryCacheLoader<TLoadParams, TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>`Abstract`

Returns EntitySecondaryCacheLoader<
TLoadParams,
TFields,
TIDField,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields,
>

`Protected` `Abstract`fetchObjectsFromDatabaseAsync

`Static`getConstructionUtilsForEntityClass

Returns EntityConstructionUtils<
TFields,
TIDField,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields,
>