API Reference / @evolu/common / Type / tuple

Function: tuple()

function tuple<Elements>(...elements): TupleType<Elements>;

Defined in: packages/common/src/Type.ts:3146

Tuple Type.

Represents a tuple of specific Types.

Example

const NameAndAge = tuple(NonEmptyTrimmedString, PositiveNumber);

const result = NameAndAge.from(["Alice", 25]); // ok(["Alice", 25])
const error = NameAndAge.from(["Alice", -10]); // err

Type Parameters

Type Parameter
Elements extends [AnyType, ...AnyType[]]

Parameters

ParameterType
...elementsElements

Returns

TupleType<Elements>

Was this page helpful?