Core

struct.tuple

Struct that parses a fixed-length array with one struct per position.

Chapter navigation

@defjs/core · Function

Signature

function tuple<
  const T extends readonly [
    StructLike<unknown, unknown, boolean>,
    ...StructLike<unknown, unknown, boolean>[],
  ],
>(items: T): TupleStruct<T>;

struct.tuple takes one array of structs, not separate arguments:

const Pair = struct.tuple([struct.string(), struct.number()]);

Each position is parsed with the struct at the same index. The input must be an array of exactly the same length, otherwise it fails with invalid_type (expected tuple of length N).
Passing the structs as separate arguments, struct.tuple(a, b), throws a TypeError.
Throws TypeError when an item is not a struct.

TupleStruct<T> is not exported. It is a Struct whose input and output are tuples of the item types.

Parameters

Prop

Type

items T

Edit this page on GitHub

STRUCT

Type-only export of the internal enumerable tag key on objects produced while parsing endpoint input, used by the outbound encoder.

Struct

Public struct contract: input and output types, modifier methods, and the _struct type brand.