Skip to main content

tuple()

tuple(fromObjectKeys)​

function tuple<T>(fromObjectKeys): SetTuple<Extract<keyof T, string>>

Creates a readonly tuple-like set of values.

This is useful for creating a set of string literals.

Type Parameters​

Type Parameter
T extends object

Parameters​

ParameterType
fromObjectKeys{ [K in string | number | symbol]: boolean }

Returns​

SetTuple<Extract<keyof T, string>>

tuple(values)​

function tuple<T>(values): SetTuple<T>

Type Parameters​

Type Parameter
T extends string

Parameters​

ParameterType
valuesIterable<T, any, any>

Returns​

SetTuple<T>

tuple(values)​

function tuple<T>(...values): SetTuple<T>

Type Parameters​

Type Parameter
T extends string

Parameters​

ParameterType
...valuesT[]

Returns​

SetTuple<T>