strictTuple

Creates a strict tuple schema.

const Schema = v.strictTuple<TItems, TMessage>(items, message);

Generics

Parameters

  • items TItems
  • message TMessage

Explanation

With strictTuple you can validate the data type of the input and whether the content matches items. If the input is not an array or does include unknown items, you can use message to customize the error message.

The difference to tuple is that this schema returns an issue for unknown items. It intentionally returns only one issue. Otherwise, attackers could send large arrays to exhaust device resources. If you want an issue for every unknown item, use the tupleWithRest schema with never for the rest argument.

Returns

Examples

The following examples show how strictTuple can be used. Please see the arrays guide for more examples and explanations.

Simple tuple schema

Schema to validate a strict tuple with two items.

const SimpleTupleSchema = v.strictTuple([v.string(), v.number()]);

The following APIs can be combined with strictTuple.

Schemas

Methods

Actions

Utils

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 Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of fabulousgk
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of andrew-d-jackson
  • GitHub profile picture of dslatkin