@cuppachino/type-space/dist/indices.d.ts

A collection of type utilities for TypeScript.

import type { NumberLiteral } from './number-literal';
import type { ParseNumberLiteral } from './parse-number-literal';
/**
 * Generates a tuple based on the length of the input array and fills each index with the index number.
 *
 * @see {@link IndexOf}
 * @see {@link NumberLiteral}
 * @see {@link ParseNumberLiteral}
 * @example
 * ```ts
 * type FruitIndices = Indices<['apple', 'banana', 'plum']> // [0, 1, 2]
 * ```
 * @example
 * Can be used to create an index union (`0 | 1 | 2 | ...`)
 * ```ts
 * type FruitIndex = Indices<['apple', 'banana', 'plum']>[number] // 0 | 1 | 2
 * ```
 */
export type Indices<T> = {
    [K in keyof T]: K extends NumberLiteral ? ParseNumberLiteral<K> : never;
};