size

Creates a pipeline validation action that validates the size of a map, set or blob.

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

Generics

  • TInput extends Map<any, any> | Set<any> | Blob
  • TRequirement extends number

Parameters

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

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 = blob([size(256, 'The blob must be 256 bytes in size.')]);

Set size schema

Schema to validate a set of 8 numbers.

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

The following APIs can be combined with size.

Schemas

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 ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper