strictTupleAsync

Creates a strict tuple schema.

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

Generics

• TItems extends TupleItemsAsync
• TMessage extends ErrorMessage<StrictTupleIssue> | undefined

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

• Schema StrictTupleSchemaAsync<TItems, TMessage>

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.')
  ),
]);

Related

The following APIs can be combined with strictTupleAsync.

Schemas

any, array, bigint, blob, boolean, custom, date, enum, exactOptional, file, function, instance, intersect, lazy, literal, looseObject, looseTuple, map, nan, never, nonNullable, nonNullish, nonOptional, null, nullable, nullish, number, object, objectWithRest, optional, picklist, promise, record, set, strictObject, string, symbol, tuple, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Methods

config, getDefault, getFallback

Actions

check, checkItems, brand, description, empty, everyItem, excludes, filterItems, findItem, flavor, guard, includes, length, mapItems, maxLength, metadata, minLength, nonEmpty, notLength, partialCheck, rawCheck, rawTransform, readonly, reduceItems, someItem, sortItems, title, transform

Utils

entriesFromList, isOfKind, isOfType

Async

arrayAsync, checkAsync, customAsync, exactOptionalAsync, fallbackAsync, getDefaultsAsync, getFallbacksAsync, intersectAsync, lazyAsync, looseObjectAsync, looseTupleAsync, mapAsync, nonNullableAsync, nonNullishAsync, nonOptionalAsync, nullableAsync, nullishAsync, objectAsync, objectWithRestAsync, optionalAsync, parseAsync, parserAsync, partialCheckAsync, pipeAsync, rawCheckAsync, rawTransformAsync, recordAsync, safeParseAsync, safeParserAsync, setAsync, strictObjectAsync, transformAsync, tupleAsync, tupleWithRestAsync, unionAsync, variantAsync