Class EntityMutationValidator<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>`Abstract`

A validator is a way to specify side-effect-free entity mutation validation that runs within the same transaction as the mutation itself.

Type Parameters

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

Index

Constructors

Methods

Constructors

constructor

new EntityMutationValidator<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TViewerContext extends ViewerContext,
    TEntity extends
        ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TSelectedFields extends string
    | number
    | symbol = keyof TFields,
>(): EntityMutationValidator<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TSelectedFields,
>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
- TSelectedFields extends string | number | symbol = keyof TFields
Returns EntityMutationValidator<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TSelectedFields,
>

Methods

`Abstract`executeAsync

executeAsync(
    viewerContext: TViewerContext,
    queryContext: EntityTransactionalQueryContext,
    entity: TEntity,
    mutationInfo: EntityValidatorMutationInfo<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): Promise<void>
Parameters
- viewerContext: TViewerContext
- queryContext: EntityTransactionalQueryContext
- entity: TEntity
- mutationInfo: EntityValidatorMutationInfo<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns Promise<void>
- Defined in packages/entity/src/EntityMutationValidatorConfiguration.ts:52