PokéRogue
    Preparing search index...

    Type Alias UnionToTuple<T, L>

    UnionToTuple: IsNever<T> extends false
        ? [...UnionToTuple<Exclude<T, L>>, L]
        : []

    Convert a union type into an unordered tuple type of its elements.

    "Unordered" means the elements of the tuple are not guaranteed to be in the same order as in the union type. The arrangement can appear random and may change at any time.

    This can be useful when you have objects with a finite set of keys and want a type defining only the allowed keys, but do not want to repeat yourself.

    Type Parameters

    import type {UnionToTuple} from 'type-fest';

    type Numbers = 1 | 2 | 3;
    type NumbersTuple = UnionToTuple<Numbers>;
    //=> [1, 2, 3]

    import type {UnionToTuple} from 'type-fest';

    const pets = {
    	dog: '🐶',
    	cat: '🐱',
    	snake: '🐍',
    };

    type Pet = keyof typeof pets;
    //=> 'dog' | 'cat' | 'snake'

    const petList = Object.keys(pets) as UnionToTuple<Pet>;
    //=> ['dog', 'cat', 'snake']

    Settings

    Member Visibility