empty

Creates an empty validation action.

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

Generics

Parameters

  • message TMessage

Explanation

With empty you can validate that a string or array is empty. If the input is not empty, you can use message to customize the error message.

Returns

Examples

The following examples show how empty can be used.

String schema

Schema to validate that a string is empty.

const StringSchema = v.pipe(v.string(), v.empty('The string must be empty.'));

Array schema

Schema to validate that an array is empty.

const ArraySchema = v.pipe(
  v.array(v.number()),
  v.empty('The array must be empty.')
);

The following APIs can be combined with empty.

Schemas

Methods

Utils

Contributors

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

  • 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 fabulousgk
  • GitHub profile picture of jdgamble555
  • GitHub profile picture of isoden
  • GitHub profile picture of nickytonline
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of luckasnix
  • GitHub profile picture of andrew-3kb
  • GitHub profile picture of dslatkin