strictTupleAsync

Creates a strict tuple schema.

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

Generics

Parameters

  • items TItems
  • message TMessage

Explanation

With strictTupleAsync 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 tupleAsync 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 tupleWithRestAsync schema with never for the rest argument.

Returns

Examples

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

Number and email tuple

Schema to validate a strict tuple with one number and one stored email address.

import { isEmailPresent } from '~/api';

const TupleSchema = v.strictTupleAsync([
  v.number(),
  v.pipeAsync(
    v.string(),
    v.email(),
    v.checkAsync(isEmailPresent, 'The email is not in the database.')
  ),
]);

The following APIs can be combined with strictTupleAsync.

Schemas

Methods

Actions

Utils

Async

Contributors

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

  • GitHub profile picture of fabian-hiller
  • GitHub profile picture of mehm8128

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 antfu
  • 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 jdgamble555
  • GitHub profile picture of isoden
  • GitHub profile picture of nickytonline
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of luckasnix
  • GitHub profile picture of andrew-3kb
  • GitHub profile picture of dslatkin