@cuppachino/type-space/dist/tuples/unshift.d.ts

A collection of type utilities for TypeScript.

import type { IgnoreMutability } from '../index.js';
import type { UnknownArray } from '../unknown-array';
/**
 * Create a tuple type with a new type inserted at the beginning. Does not return the length of the tuple.
 *
 * @remarks Its worth noting `Pop`, `Push`, `Shift`, and `Unshift` are inspired by JS; however, the types are not 1:1 for design reasons. More information can be found in [README](https://github.com/Cuppachino/type-space/#type-space).
 * @example
 * ```
 * declare const tuple: [2, 3]
 * type Tuple = Unshift<typeof tuple, 1> // [1, 2, 3]
 * ```
 */
export type Unshift<T extends UnknownArray, V> = IgnoreMutability<T> extends T ? readonly [V, ...T] : [V, ...T];