minBytes

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

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

Generics

• TInput extends string
• TRequirement extends number

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With minBytes 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 MinBytesValidation<TInput, TRequirement>

Examples

The following examples show how minBytes can be used.

Min bytes schema

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

const MinBytesSchema = string([
  minBytes(64, 'The string must contain at least 64 bytes.'),
]);

Related

The following APIs can be combined with minBytes.

Schemas

• any,
• special,
• string,
• unknown