import type {If} from './if.d.ts'; import type {IfNotAnyOrNever} from './internal/type.d.ts'; import type {IsNegative} from './numeric.d.ts'; import type {UnknownArray} from './unknown-array.d.ts'; /** Create a tuple type of the specified length with elements of the specified type. @example ``` import type {TupleOf} from 'type-fest'; type RGB = TupleOf<3, number>; //=> [number, number, number] type Line = TupleOf<2, {x: number; y: number}>; //=> [{x: number; y: number}, {x: number; y: number}] type TicTacToeBoard = TupleOf<3, TupleOf<3, 'X' | 'O' | null>>; //=> [['X' | 'O' | null, 'X' | 'O' | null, 'X' | 'O' | null], ['X' | 'O' | null, 'X' | 'O' | null, 'X' | 'O' | null], ['X' | 'O' | null, 'X' | 'O' | null, 'X' | 'O' | null]] ``` @example ``` type Range = Exclude, keyof TupleOf>; type ZeroToFour = Range<0, 5>; //=> '0' | '1' | '2' | '3' | '4' type ThreeToEight = Range<3, 9>; //=> '3' | '4' | '5' | '6' | '7' | '8' ``` Note: If the specified length is the non-literal `number` type, the result will not be a tuple but a regular array. @example ``` import type {TupleOf} from 'type-fest'; type StringArray = TupleOf; //=> string[] ``` Note: If the type for elements is not specified, it will default to `unknown`. @example ``` import type {TupleOf} from 'type-fest'; type UnknownTriplet = TupleOf<3>; //=> [unknown, unknown, unknown] ``` Note: If the specified length is negative, the result will be an empty tuple. @example ``` import type {TupleOf} from 'type-fest'; type EmptyTuple = TupleOf<-3, string>; //=> [] ``` Note: If you need a readonly tuple, simply wrap this type with `Readonly`, for example, to create `readonly [number, number, number]` use `Readonly>`. @category Array */ export type TupleOf = IfNotAnyOrNever, 0, Length>, Fill, []>, Fill[], []>; type _TupleOf = number extends L ? Fill[] : L extends Accumulator['length'] ? Accumulator : _TupleOf; export {};