tupleWithRest

Creates a tuple with rest schema.

const Schema = v.tupleWithRest<TItems, TRest, TMessage>(items, rest, message);

Generics

• TItems extends TupleItems
• TRest extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<TupleWithRestIssue> | undefined

Parameters

• items TItems
• rest TRest
• message TMessage

Explanation

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

Returns

• Schema TupleWithRestSchema<TItems, TRest, TMessage>

Examples

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

Tuple schema with rest

Schema to validate a tuple with generic rest items.

const TupleSchemaWithRest = v.tupleWithRest(
  [v.string(), v.number()],
  v.boolean()
);

Related

The following APIs can be combined with tupleWithRest.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• custom,
• date,
• enum,
• 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,
• strictTuple,
• string,
• symbol,
• tuple,
• undefined,
• union,
• unknown,
• variant,
• void

Methods

• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• pipe,
• safeParse

Actions

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