Tuple schema

A function which creates a parsing rule to ensure that a given value is a tuple.

Arguments

schemas - A tuple of schemas
message? - A custom object with error messages to be displayed when validation fails or there are type errors

Examples

import { tuple, string, number } from '@nordic-ui/validathor';
 
const tupleRule = tuple([string(), number()]);
 
try {
  const parsedValue = tupleRule.parse(['Hello', 123]);
  console.log('Parsed value:', parsedValue);
} catch (error) {
  console.error('Parsing failed:', error.message);
}

TypeScript

To get the type of a schema, you can do the following:

const tupleRule = tuple([string(), number()]);
 
type TupleSchema = ReturnType<typeof tupleRule.parse>; // [string, number]

String Union