bytes

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

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

Generics

• TInput extends string
• TRequirement extends number

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With bytes 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 BytesValidation<TInput, TRequirement>

Examples

The following examples show how bytes can be used.

Bytes schema

Schema to validate a string with 8 bytes

const BytesSchema = string([bytes(8, 'Exactly 8 bytes are required.')]);

Related

The following APIs can be combined with bytes.

Schemas

• any,
• special,
• string,
• unknown