maxBytes

Creates a pipeline validation action that validates the bytes of a string.

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

Generics

• TInput extends string
• TRequirement extends number

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With maxBytes you can validate the bytes of a string. If the input does not match the requirement, you can use message to customize the error message.

Returns

• Validation MaxBytesValidation<TInput, TRequirement>

Examples

The following examples show how maxBytes can be used.

Max bytes schema

Schema to validate a string with a maximum of 64 bytes.

const MaxBytesSchema = string([
  maxBytes(64, 'The string must not exceed 64 bytes.'),
]);

Related

The following APIs can be combined with maxBytes.

Schemas

• any,
• special,
• string,
• unknown