Type Alias ModelValidatorComponent<TData, TModelExtensions, TModelInstanceExtensions>

ModelValidatorComponent: (
    instance: ModelInstance<
        TData,
        TModelExtensions,
        TModelInstanceExtensions,
    >,
    instanceData: ToObjectResult<TData>,
    context: ValidatorContext,
) => Promise<ComponentValidationErrorResponse>

The component of a Model Validator. These are combined to create a single model validator.

Type Parameters

TData extends DataDescription
TModelExtensions extends object = object
TModelInstanceExtensions extends object = object

Type declaration

- (
      instance: ModelInstance<
          TData,
          TModelExtensions,
          TModelInstanceExtensions,
      >,
      instanceData: ToObjectResult<TData>,
      context: ValidatorContext,
  ): Promise<ComponentValidationErrorResponse>
- Parameters
  - instance: ModelInstance<TData, TModelExtensions, TModelInstanceExtensions>
    The instance of the model.
  - instanceData: ToObjectResult<TData>
    The JSONified version of the model.
  - context: ValidatorContext
    Additional context to assist with validating.
  Returns Promise<ComponentValidationErrorResponse>