Class EntityLoaderFactory<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

The primary entry point for loading entities.

Type Parameters

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

Index

Constructors

constructor

new EntityLoaderFactory<
    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,
>(
    entityCompanion: EntityCompanion<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
    dataManager: EntityDataManager<TFields, TIDField>,
    metricsAdapter: IEntityMetricsAdapter,
): EntityLoaderFactory<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
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
Parameters
- entityCompanion: EntityCompanion<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
- dataManager: EntityDataManager<TFields, TIDField>
- metricsAdapter: IEntityMetricsAdapter
Returns EntityLoaderFactory<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in packages/entity/src/EntityLoaderFactory.ts:28

Properties

`Protected` `Readonly`metricsAdapter

metricsAdapter: IEntityMetricsAdapter

Methods

forLoad

forLoad(
    viewerContext: TViewerContext,
    queryContext: EntityQueryContext,
    privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): AuthorizationResultBasedEntityLoader<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Vend loader for loading an entity in a given query context.
Parameters
- viewerContext: TViewerContext
  viewer context of loading user
- queryContext: EntityQueryContext
  query context in which to perform the load
- privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns AuthorizationResultBasedEntityLoader<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in packages/entity/src/EntityLoaderFactory.ts:46

Class EntityLoaderFactory<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

`Protected` `Readonly`metricsAdapter

Methods

forLoad

Parameters

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

Settings

On This Page

Class EntityLoaderFactory<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Protected ReadonlymetricsAdapter

Methods

forLoad

Parameters

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

Settings

On This Page

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

`Protected` `Readonly`metricsAdapter

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