tuple

Creates a tuple schema.

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

Generics

Parameters

  • items TItems
  • message TMessage

Explanation

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

This schema removes unknown items. The output will only include the items you specify. To include unknown items, use looseTuple. To return an issue for unknown items, use strictTuple. To include and validate unknown items, use tupleWithRest.

Returns

Examples

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

Simple tuple schema

Schema to validate a tuple with two items.

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

The following APIs can be combined with tuple.

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 dailydotdev
  • GitHub profile picture of Thanaen
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz