Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions<T, D>

Type parameters

Hierarchy

  • IOptions

Index

Properties

Optional castHandler

castHandler: boolean | CastHandler

True to enable casting using Yup internally, false or null to disable or custom function for user defined model value casting.

Optional cleanVanities

cleanVanities: boolean

When true vanity properties such as virtuals and non top level model properties are cleaned to return model to pure state.

Optional defaults

defaults: Partial<D> | Promise<Partial<D>>

Default model values (default: {})

Optional normalizedDefaults

normalizedDefaults: any

Internal defaults parsed from yup or user.

Optional onValidated

onValidated: (model?: T & Partial<D>, errors?: ErrorModel<T & Partial<D>>) => void

Called when model is validated.

Type declaration

    • (model?: T & Partial<D>, errors?: ErrorModel<T & Partial<D>>): void
    • Parameters

      • Optional model: T & Partial<D>
      • Optional errors: ErrorModel<T & Partial<D>>

      Returns void

Optional promisifiedDefaults

promisifiedDefaults: Partial<D> | Promise<Partial<D>>

Defaults normalized to a promise.

Optional validateBlur

validateBlur: boolean

When true validation is triggered on blur (default: true)

Optional validateChange

validateChange: boolean

When true validation is triggered on change (default: false)

Optional validateInit

validateInit: boolean

When true validation is triggered when form is first initialized (default: false)

Optional validateNative

validateNative: boolean

When true and validationSchema is NOT user function native validation converted to yup ObjectSchema (default: true)

Optional validateSubmit

validateSubmit: boolean

When true validation is triggered on submit (default: true)

Optional validateSubmitExit

validateSubmitExit: boolean

When true validation is triggered on submit if error halts submit (default: false) Defaults to false so user opts in can see submissions are working.

Optional validationSchema

validationSchema: ValidationSchema<T & Partial<D>>

A Yup ObjectSchema or custom function for validating form (default: undefined)

Optional validationSchemaPurge

validationSchemaPurge: boolean

When true

Generated using TypeDoc