Class ArrayType<TElementField, TRequired>

constructor

• new ArrayType<
      TElementField extends SchemaFieldLike = Type<unknown, false>,
      TRequired extends boolean = false,
  >(
      elementType?: TElementField,
      options?: Record<string, unknown>,
  ): ArrayType<TElementField, TRequired>

  Type Parameters

  • TElementField extends SchemaFieldLike = Type<unknown, false>
  • TRequired extends boolean = false

  Parameters

  • elementType: TElementField = null
  • options: Record<string, unknown> = {}

  Returns ArrayType<TElementField, TRequired>

elementType

required

• required<T extends boolean = true>(isRequired?: T): ArrayType<TElementField, T>

  Mark the field as required or optional.

  Type Parameters

  • T extends boolean = true

  Parameters

  • isRequired: T = ...

  Returns ArrayType<TElementField, T>

validate

• validate(
      value: unknown,
      fieldName?: string,
  ): TypeOutput<InferFieldValue<TElementField>[], TRequired>

  Validate the supplied value and return the normalized result.

  Parameters

  • value: unknown
  • fieldName: string = 'field'

  Returns TypeOutput<InferFieldValue<TElementField>[], TRequired>