Class ViewerScopedEntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Provides a cleaner API for loading entities by passing through the ViewerContext.

Type Parameters

TFields extends object
TID extends NonNullable<TFields[TSelectedFields]>
TViewerContext extends ViewerContext
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
TSelectedFields extends keyof TFields

Index

Constructors

Methods

Constructors

constructor

new ViewerScopedEntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(entityLoaderFactory, viewerContext): ViewerScopedEntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Type Parameters
- TFields extends object
- TID extends {}
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol
Parameters
- entityLoaderFactory: EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- viewerContext: TViewerContext
Returns ViewerScopedEntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityLoaderFactory.ts:25

Methods

forLoad

forLoad(queryContext, privacyPolicyEvaluationContext): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Parameters
- queryContext: EntityQueryContext
- privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<TFields, TID, TViewerContext, TEntity, TSelectedFields>
Returns EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityLoaderFactory.ts:37