$tuple

Callable

• $tuple<Elements, Rest>(items: ConstExprTuple<Elements>, options?: SchemaOptions<TupleOptions<Rest>, TupleToInfer<Elements>>): TupleType<Elements, Rest>

---

• Create a new TupleType instance with the given options.

  Example

  $tuple([$integer, $string])

  ---

  Type parameters

  • Elements: [Node, ...Node[]] = [Node, ...Node[]]
  • Rest: undefined | Node = undefined

  Parameters

  • items: ConstExprTuple<Elements>

    The items in the tuple.

  • options: SchemaOptions<TupleOptions<Rest>, TupleToInfer<Elements>> = {}

    Additional options to pass to the tuple.

  Returns TupleType<Elements, Rest>