Typescript: Allow inferring rest element types in conditional types involving tuples

Created on 17 Jul 2018  ·  5Comments  ·  Source: microsoft/TypeScript

Search Terms

rest element infer tuple

Suggestion

Currently, inferring single elements of tuple types is possible using the infer keyword:

type FirstArg<T extends any[]> = 
    T extends [infer R, ...any[]] ? R : 
    T extends [] ? undefined : 
    never;
type T1 = FirstArg<[number, 2, 3]>; // number
type T2 = FirstArg<[1, 2, 3]>; // 1
type T3 = FirstArg<["", 2]>; // ""
type T4 = FirstArg<[]>; // undefined

However it is not possible to infer the type of the remaining arguments in one go, except by resorting to functions:

type RestArgs<T extends any[]> = 
    T extends [any, infer R[]] ? R : // this does not work - no way to specify that R should be an array!
    T extends [any] ? []] : 
    never;

// this does
type RestArgs<T extends any[]> =
    ((...args: T) => void) extends ((first: any, ...rest: infer S1) => void) ? S1
    : T extends [infer S2] ? []
    : T extends [] ? []
    : never;
type T1 = RestArgs<[1,2,3]>; // [2, 3]
type T2 = RestArgs<[1,2]>; // [2]
type T3 = RestArgs<[1]>; // []
type T4 = RestArgs<[]>; // []

I would like to see the possibility to infer rest types in tuples, e.g. like this (square brackets):

type RestArgs<T extends any[]> = T extends [any, infer R[]] ? R : never;

or like this (3 dots)

type RestArgs<T extends any[]> = T extends [any, infer ...R] ? R : never;

Checklist

My suggestion meets these guidelines:

  • [x] This wouldn't be a breaking change in existing TypeScript / JavaScript code
  • [x] This wouldn't change the runtime behavior of existing JavaScript code
  • [x] This could be implemented without emitting different JS based on the types of the expressions
  • [x] This isn't a runtime feature (e.g. new expression-level syntax)
In Discussion Suggestion

Most helpful comment

The current workaround:

type Tail<T extends any[]> = ((...args: T) => any) extends ((
    _: infer First,
    ...rest: infer Rest
) => any)
    ? T extends any[] ? Rest : ReadonlyArray<Rest[number]>
    : []

Note: Does not work in TypeScript 2.9.x and under.

All 5 comments

I just ran into this issue myself and wanted to throw in my two cents about the syntax for how this would behave. Considering how this inference is written for function types and how rest elements of tuples are constructed:

type Tail<T> = T extends (head: any, ...tail: infer U) ? U : never;

type Rest = string[];
type Tuple = [any, ...Rest];

I would suggest the following syntax:

type Tail<T> = T extends [any, ...infer U] ? U : never;

The current workaround:

type Tail<T extends any[]> = ((...args: T) => any) extends ((
    _: infer First,
    ...rest: infer Rest
) => any)
    ? T extends any[] ? Rest : ReadonlyArray<Rest[number]>
    : []

Note: Does not work in TypeScript 2.9.x and under.

@AlCalzone - Thanks for the examples FirstArg and RestArgs. They inspired these additional examples:

export type Length<T extends any[]> = T extends (infer U)[] & { length: infer L } ? L : never;
export type LengthMinusOne<T extends any[]> = Length<Tail<T>>;
export type LengthPlusOne<T extends any[]> = Length<Cons<any, T>>;
export type Last<T extends any[]> = T[LengthMinusOne<T>];
// Example:
// export type TestLastType = Last<[boolean, string, number]>; //number

Based on the above, it would be great to have something like:

type Last<T extends any[]> = T extends [...any[], infer L] ? L : never;
type Tail<A extends any[]> = 
  ((...args: A) => any) extends ((h: any, ...t: infer T) => any) ? T : never

This works in TypeScript v4 (via variadic tuple types):

type Tail<T extends any[]> = T extends [any, ...infer U] ? U : never;

Was this page helpful?
0 / 5 - 0 ratings

Related issues

manekinekko picture manekinekko  ·  3Comments

uber5001 picture uber5001  ·  3Comments

siddjain picture siddjain  ·  3Comments

seanzer picture seanzer  ·  3Comments

fwanicka picture fwanicka  ·  3Comments