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

Provides a cleaner API for mutating 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

forCreate forDelete forUpdate

Constructors

constructor

new ViewerScopedEntityMutatorFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(entityMutatorFactory, viewerContext): ViewerScopedEntityMutatorFactory<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
- entityMutatorFactory: EntityMutatorFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- viewerContext: TViewerContext
Returns ViewerScopedEntityMutatorFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityMutatorFactory.ts:25

Methods

forCreate

forCreate(queryContext): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Parameters
- queryContext: EntityQueryContext
Returns CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityMutatorFactory.ts:37

forDelete

forDelete(existingEntity, queryContext): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Parameters
- existingEntity: TEntity
- queryContext: EntityQueryContext
Returns DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityMutatorFactory.ts:50

forUpdate

forUpdate(existingEntity, queryContext): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Parameters
- existingEntity: TEntity
- queryContext: EntityQueryContext
Returns UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityMutatorFactory.ts:43