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

requirement TRequirement
message ErrorMessage | undefined

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

Validation SizeValidation<TInput, TRequirement>

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

any,
array,
instance,
special,
string,
tuple,
unknown