boolean

Creates a boolean schema.

const Schema = boolean<TMessage>(message);

Generics

Parameters

  • message TMessage

Explanation

With boolean you can validate the data type of the input. If the input is not a boolean, you can use message to customize the error message.

Instead of using a pipe to force true or false as a value, in most cases it makes more sense to use literal for better typing.

Returns

Examples

The following examples show how boolean can be used.

Custom message

Boolean schema with a custom error message.

const BooleanSchema = v.boolean('A boolean is required');

The following APIs can be combined with boolean.

Schemas

Methods

Transformations

Validations

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller
  • GitHub profile picture of wout-junius

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz