Typescript: Retrieve element type information from array type

Typescript

Typescript Problem Overview


Say I have some array type T[], is it possible to extract the type T within another alias / interface? For example my (fake) ideal code would be as follows:

// for illustration only...

type ArrayElement<T[]> = T;

// then, ArrayElement<string[]> === string

If no, are there general type theory reasons for not allowing such an operator? If no again, I might suggest it be added.

Thanks!

Typescript Solutions


Solution 1 - Typescript

Update: based on @jerico's answer below

The following type alias will return the type of the elements in an array or tuple:

type ArrayElement<ArrayType extends readonly unknown[]> = 
  ArrayType extends readonly (infer ElementType)[] ? ElementType : never;

So these examples would work:

type A = ArrayElement<string[]>; // string
type B = ArrayElement<readonly string[]>; // string
type C = ArrayElement<[string, number]>; // string | number
type D = ArrayElement<["foo", "bar"]>; // "foo" | "bar"
type E = ArrayElement<(P | (Q | R))[]>; // P | Q | R

type Error1 = ArrayElement<{ name: string }>; 
//                         ^^^^^^^^^^^^^^^^
// Error: Type '{ name: string; }' does not satisfy the constraint 'readonly unknown[]'.

Explanation

The type guard (the bit in the angle brackets) ArrayType extends readonly unknown[] says that we expect the type parameter ArrayType to be at least a readonly array (it also accepts a mutable array) so that we can look at its element type.

This prevents passing in a non-array value, as in the final example, which prevents ArrayElement ever returning never.

Note that readonly unknown[] is syntax added in TypeScript 3.4; for earlier versions use ReadonlyArray<unknown>.

On the right-hand side, the conditional expression asks the compiler to fill in the value of ElementType in the pattern readonly ElementType[] and return ElementType if it can, or never if it can't.

Since the type guard at the beginning means we will only ever be passed a value which matches this pattern, it's guaranteed always to match and never to return never.

Previous answer

type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];

Solution 2 - Typescript

Since 2.1, typescript supports [ ] operator for types. The official name is indexed access types, also called lookup types, and it works like this:

type A = {a: string, b: number} [];

type AElement = A[0];

let e: AElement = {x: 0}; //error TS2322: Type '{ x: number; }' is not 
                       //assignable to type '{ a: string; b: number; }'

Solution 3 - Typescript

Another alternative:

type ArrayElement<A> = A extends readonly (infer T)[] ? T : never

Solution 4 - Typescript

The easiest way to do this would be:

type ArrayElementType = ArrayType[number];

Update

As a comment below suggests, to create a generic array element type:

type ArrayElementType<ArrayType extends Array> = ArrayType[number];

P.S. number is not an integer but a type.

Solution 5 - Typescript

The utility-type library has a type for that https://github.com/piotrwitek/utility-types#valuestypet (along with many others)

For example

import { ValuesType } from 'utility-types';

type NumberArray = number[];
// Expect: number
type NumberItems = ValuesType<NumberArray>;

Solution 6 - Typescript

Another option:

type Flatten<Type> = Type extends Array<infer Item> ? Item : Type;

You can find more about infer at: https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#inferring-within-conditional-types:

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionBen SouthgateView Question on Stackoverflow
Solution 1 - TypescriptWill MaddenView Answer on Stackoverflow
Solution 2 - TypescriptartemView Answer on Stackoverflow
Solution 3 - TypescriptjericoView Answer on Stackoverflow
Solution 4 - TypescriptzilijonasView Answer on Stackoverflow
Solution 5 - TypescriptlbessonView Answer on Stackoverflow
Solution 6 - TypescriptDamian KurekView Answer on Stackoverflow