maxSize

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

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

Generics

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

Parameters

requirement TRequirement
message ErrorMessage | undefined

Explanation

With maxSize 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 MaxSizeValidation<TInput, TRequirement>

Examples

The following examples show how maxSize can be used.

Blob size schema

Schema to validate a blob with a maximum size of 10 MB.

const BlobSchema = blob([
  maxSize(10 * 1024 * 1024, 'The blob must not exceed 10 MB.'),
]);

Set size schema

Schema to validate a set with a maximum of 8 numbers.

const SetSchema = set(number(), [
  maxSize(8, 'The set must not exceed 8 numbers.'),
]);

The following APIs can be combined with maxSize.