values

Creates a values validation action.

const Action = v.values<TInput, TRequirement, TMessage>(requirement, message);

Generics

Parameters

  • requirement TRequirement
  • message TMessage

Explanation

With values you can validate the value of a string, number, boolean or date. If the input does not match one of the values in the requirement, you can use message to customize the error message.

This action does not change the type of the pipeline. Use the picklist schema instead if you want the type to match the union of specific values.

Returns

Examples

The following examples show how values can be used.

Number schema

Schema to validate a number with specific values.

const NumberSchema = v.pipe(
  v.number(),
  v.values([5, 15, 20], 'The number must be one of the allowed numbers.')
);

The following APIs can be combined with values.

Schemas

Methods

Utils

Contributors

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

  • GitHub profile picture of EltonLobo07
  • GitHub profile picture of fabian-hiller

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 antfu
  • GitHub profile picture of Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of Unique-Pixels
  • GitHub profile picture of jdgamble555
  • GitHub profile picture of nickytonline
  • GitHub profile picture of KubaJastrz
  • GitHub profile picture of andrewmd5
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of dslatkin