type-fest/source/exclude-rest-element.d.ts
2025-11-30 04:44:57 +07:00

41 lines
1.1 KiB
TypeScript

import type {SplitOnRestElement} from './split-on-rest-element.d.ts';
import type {IsArrayReadonly} from './internal/array.d.ts';
import type {UnknownArray} from './unknown-array.d.ts';
import type {IfNotAnyOrNever} from './internal/type.d.ts';
/**
Create a tuple with the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element removed.
@example
```
import type {ExcludeRestElement} from 'type-fest';
type T1 = ExcludeRestElement<[number, ...string[], string, 'foo']>;
//=> [number, string, 'foo']
type T2 = ExcludeRestElement<[...boolean[], string]>;
//=> [string]
type T3 = ExcludeRestElement<[...Array<'foo'>, true]>;
//=> [true]
type T4 = ExcludeRestElement<[number, string]>;
//=> [number, string]
```
@see {@link ExtractRestElement}
@see {@link SplitOnRestElement}
@category Array
*/
export type ExcludeRestElement<Array_ extends UnknownArray> = IfNotAnyOrNever<Array_,
SplitOnRestElement<Array_> extends infer Result
? Result extends readonly UnknownArray[]
? IsArrayReadonly<Array_> extends true
? Readonly<[...Result[0], ...Result[2]]>
: [...Result[0], ...Result[2]]
: never
: never
>;
export {};