Indexed Access Types
We can use an indexed access type to look up a specific property on another type:
ts
typePerson = {age : number;name : string;alive : boolean };typeAge =Person ["age"];type Age = number
The indexing type is itself a type, so we can use unions, keyof
, or other types entirely:
ts
typeI1 =Person ["age" | "name"];type I1 = string | numbertypeI2 =Person [keyofPerson ];type I2 = string | number | booleantypeAliveOrName = "alive" | "name";typeI3 =Person [AliveOrName ];type I3 = string | boolean
You’ll even see an error if you try to index a property that doesn’t exist:
ts
typeProperty 'alve' does not exist on type 'Person'.2339Property 'alve' does not exist on type 'Person'.I1 =Person ["alve" ];
Another example of indexing with an arbitrary type is using number
to get the type of an array’s elements. We can combine this with typeof
to conveniently capture the element type of an array literal:
ts
constMyArray = [{name : "Alice",age : 15 },{name : "Bob",age : 23 },{name : "Eve",age : 38 },];typePerson = typeofMyArray [number];type Person = {
name: string;
age: number;
}typeAge = typeofMyArray [number]["age"];type Age = number// OrtypeAge2 =Person ["age"];type Age2 = number
You can only use types when indexing, meaning you can’t use a const
to make a variable reference:
ts
constkey = "age";typeType 'any' cannot be used as an index type.Age =Person []; key
'key' refers to a value, but is being used as a type here. Did you mean 'typeof key'?2538
2749Type 'any' cannot be used as an index type.
'key' refers to a value, but is being used as a type here. Did you mean 'typeof key'?
However, you can use a type alias for a similar style of refactor:
ts
typekey = "age";typeAge =Person [key ];