FormBuilderWithReason

^{ref / conversations / FormBuilderWithReason}

An object that fully specifies how to build a form field.

Contains as properties of FormConfigWithReason as well as a function that can validate context objects. If a context object does not pass validation, the validation function is able to provide a reason.

If the validation function cannot provide reason as to why validation has failed, it is possible to use FormBuilder instead.

^Source

Extends

FormConfigWithReason<C, T, R>

Methods

validate

validate(ctx: C): Result<T, R> | Promise<Result<T, R>>;

A function that validates a given context.

When validation succeeds, a value can be extracted from the context object. When validation fails, an error can be generated. The result of the validation needs to be encoded using a Result type.

^Source