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

Mutator for updating an existing entity.

Type Parameters

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

Hierarchy

BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- UpdateMutator

Index

Constructors

constructor

new UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(companionProvider, viewerContext, queryContext, entityConfiguration, entityClass, privacyPolicy, mutationValidators, mutationTriggers, entityLoaderFactory, databaseAdapter, metricsAdapter, originalEntity): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Type Parameters
- TFields extends object
- TID extends {}
- TViewerContext extends ViewerContext
- TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol
Parameters
- companionProvider: EntityCompanionProvider
- viewerContext: TViewerContext
- queryContext: EntityQueryContext
- entityConfiguration: EntityConfiguration<TFields>
- entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- privacyPolicy: TPrivacyPolicy
- mutationValidators: EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
- mutationTriggers: EntityMutationTriggerConfiguration<TFields, TID, TViewerContext, TEntity, TSelectedFields>
- entityLoaderFactory: EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- databaseAdapter: EntityDatabaseAdapter<TFields>
- metricsAdapter: IEntityMetricsAdapter
- originalEntity: TEntity
Returns UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Overrides BaseMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>.constructor
- Defined in packages/entity/src/EntityMutator.ts:314

Properties

`Protected` `Readonly`companionProvider

companionProvider: EntityCompanionProvider

`Protected` `Readonly`databaseAdapter

databaseAdapter: EntityDatabaseAdapter<TFields>

`Protected` `Readonly`entityClass

entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

`Protected` `Readonly`entityConfiguration

entityConfiguration: EntityConfiguration<TFields>

`Protected` `Readonly`entityLoaderFactory

entityLoaderFactory: EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

`Protected` `Readonly`metricsAdapter

metricsAdapter: IEntityMetricsAdapter

`Protected` `Readonly`mutationTriggers

mutationTriggers: EntityMutationTriggerConfiguration<TFields, TID, TViewerContext, TEntity, TSelectedFields>

`Protected` `Readonly`mutationValidators

mutationValidators: EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]

`Protected` `Readonly`privacyPolicy

privacyPolicy: TPrivacyPolicy

`Protected` `Readonly`queryContext

queryContext: EntityQueryContext

`Protected` `Readonly`viewerContext

viewerContext: TViewerContext

Methods

enforceUpdateAsync

enforceUpdateAsync(): Promise<TEntity>
Convenience method that returns the updated entity or throws upon update failure.

Returns Promise<TEntity>
- Defined in packages/entity/src/EntityMutator.ts:398

`Protected`executeMutationTriggersAsync

executeMutationTriggersAsync(triggers, queryContext, entity, mutationInfo): Promise<void>
Parameters
- triggers: undefined | EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
- queryContext: EntityTransactionalQueryContext
- entity: TEntity
- mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
Returns Promise<void>
Inherited from BaseMutator.executeMutationTriggersAsync
- Defined in packages/entity/src/EntityMutator.ts:114

`Protected`executeMutationValidatorsAsync

executeMutationValidatorsAsync(validators, queryContext, entity, mutationInfo): Promise<void>
Parameters
- validators: EntityMutationValidator<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
- queryContext: EntityTransactionalQueryContext
- entity: TEntity
- mutationInfo: EntityValidatorMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
Returns Promise<void>
Inherited from BaseMutator.executeMutationValidatorsAsync
- Defined in packages/entity/src/EntityMutator.ts:95

`Protected`executeNonTransactionalMutationTriggersAsync

executeNonTransactionalMutationTriggersAsync(triggers, entity, mutationInfo): Promise<void>
Parameters
- triggers: undefined | EntityNonTransactionalMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
- entity: TEntity
- mutationInfo: EntityTriggerMutationInfo<TFields, TID, TViewerContext, TEntity, TSelectedFields>
Returns Promise<void>
Inherited from BaseMutator.executeNonTransactionalMutationTriggersAsync
- Defined in packages/entity/src/EntityMutator.ts:132

setField

setField<K>(fieldName, value): this
Set the value for entity field.
Type Parameters
- K extends string | number | symbol
Parameters
- fieldName: K
  entity field being updated
- value: TFields[K]
  value for entity field
Returns this
- Defined in packages/entity/src/EntityMutator.ts:376

updateAsync

updateAsync(): Promise<Result<TEntity>>
Commit the changes to the entity after authorizing against update privacy rules. Invalidates all caches for pre-update entity.

Returns Promise<Result<TEntity>>
authorized updated entity result, where result error can be UnauthorizedError
- Defined in packages/entity/src/EntityMutator.ts:387

`Protected`validateFields

validateFields(fields): void
Parameters
- fields: Partial<TFields>
Returns void
Inherited from BaseMutator.validateFields
- Defined in packages/entity/src/EntityMutator.ts:83

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

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Properties

Protected ReadonlycompanionProvider

Protected ReadonlydatabaseAdapter

Protected ReadonlyentityClass

Protected ReadonlyentityConfiguration

Protected ReadonlyentityLoaderFactory

Protected ReadonlymetricsAdapter

Protected ReadonlymutationTriggers

Protected ReadonlymutationValidators

Protected ReadonlyprivacyPolicy

Protected ReadonlyqueryContext

Protected ReadonlyviewerContext

Methods

enforceUpdateAsync

Returns Promise<TEntity>

ProtectedexecuteMutationTriggersAsync

Parameters

Returns Promise<void>

ProtectedexecuteMutationValidatorsAsync

Parameters

Returns Promise<void>

ProtectedexecuteNonTransactionalMutationTriggersAsync

Parameters

Returns Promise<void>

setField

Type Parameters

Parameters

Returns this

updateAsync

Returns Promise<Result<TEntity>>

ProtectedvalidateFields

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`companionProvider

`Protected` `Readonly`databaseAdapter

`Protected` `Readonly`entityClass

`Protected` `Readonly`entityConfiguration

`Protected` `Readonly`entityLoaderFactory

`Protected` `Readonly`metricsAdapter

`Protected` `Readonly`mutationTriggers

`Protected` `Readonly`mutationValidators

`Protected` `Readonly`privacyPolicy

`Protected` `Readonly`queryContext

`Protected` `Readonly`viewerContext

`Protected`executeMutationTriggersAsync

`Protected`executeMutationValidatorsAsync

`Protected`executeNonTransactionalMutationTriggersAsync

`Protected`validateFields