size

Creates a size validation action.

const Action = size<TInput, TRequirement, TMessage>(requirement, message);

Generics

Parameters

  • requirement TRequirement
  • message TMessage

Explanation

With size you can validate the size of a map, set or blob. If the input does not match the requirement, you can use message to customize the error message.

Returns

  • Action SizeAction<TInput, TRequirement, TMessage>

Examples

The following examples show how size can be used.

Blob size schema

Schema to validate a blob with a size of 256 bytes.

const BlobSchema = v.pipe(
  v.blob(),
  v.size(256, 'The blob must be 256 bytes in size.')
);

Set size schema

Schema to validate a set of 8 numbers.

const SetSchema = v.pipe(
  v.set(number()),
  v.size(8, 'The set must contain 8 numbers.')
);

The following APIs can be combined with size.

Schemas

Methods

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 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