Class FormSchemaBuilder

Builds schema which defines shape of the form values and type of validation errors. The schema is used not only for compile-time type-safety but also for runtime validation of form values. The schema can be defined top-level, so that it can be exported to nested Form components for usage together with useField hook.

Example

import { FormSchemaBuilder, FormFields } from "@virtuslab/formts"

const Schema = new FormSchemaBuilder()
  .fields({
    name: FormFields.string(),
    age: FormFields.number(),
  })
  .errors<string>()
  .build()
Copy

Define form errors to be used by FormValidatorBuilder.

Example

new FormSchemaBuilder()
  .errors<MyErrorCodesEnum>()
Copy

Define form fields as dictionary of decoders. Use FormFields import.

Example

new FormSchemaBuilder()
  .fields({
    name: FormFields.string(),
    age: FormFields.number(),
  })
Copy