maxBytes

Creates a max bytes validation action.

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

Generics

  • TInput extends string
  • TRequirement extends number
  • TMessage extends ErrorMessage<MaxBytesIssue<TInput, TRequirement>> | undefined

Parameters

  • requirement TRequirement
  • message TMessage

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

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 = v.pipe(
  v.string(),
  v.maxBytes(64, 'The string must not exceed 64 bytes.')
);

The following APIs can be combined with maxBytes.

Schemas

Methods

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz