前言

TypeScript 的官方文档早已更新，但我能找到的中文文档都还停留在比较老的版本。所以对其中新增以及修订较多的一些章节进行了翻译整理。

本篇整理自 TypeScript Handbook 中 「Indexed Access Types」 章节。

本文并不严格按照原文翻译，对部分内容也做了解释补充。

正文

我们可以使用索引访问类型（indexed access type）查找另外一个类型上的特定属性：

  1. type Person = { age: number; name: string; alive: boolean };
  2. type Age = Person["age"];
  3. // type Age = number

因为索引名本身就是一个类型，所以我们也可以使用联合、keyof 或者其他类型：

  1. type I1 = Person["age" | "name"];  
  2. // type I1 = string | number
  4. type I2 = Person[keyof Person];
  5. // type I2 = string | number | boolean
  7. type AliveOrName = "alive" | "name";
  8. type I3 = Person[AliveOrName];  
  9. // type I3 = string | boolean

如果你尝试查找一个不存在的属性，TypeScript 会报错：

  1. type I1 = Person["alve"];
  2. // Property 'alve' does not exist on type 'Person'.

接下来是另外一个示例，我们使用 number 来获取数组元素的类型。结合 typeof 可以方便的捕获数组字面量的元素类型：

  1. const MyArray = [
  2.   { name: "Alice", age: 15 },
  3.   { name: "Bob", age: 23 },
  4.   { name: "Eve", age: 38 },
  5. ];
  7. type Person = typeof MyArray[number];
  9. // type Person = {
  10. //    name: string;
  11. //    age: number;
  12. // }
  14. type Age = typeof MyArray[number]["age"];  
  15. // type Age = number
  17. // Or
  18. type Age2 = Person["age"];   
  19. // type Age2 = number

作为索引的只能是类型，这意味着你不能使用 const 创建一个变量引用：

  1. const key = "age";
  2. type Age = Person[key];
  4. // Type 'key' cannot be used as an index type.
  5. // 'key' refers to a value, but is being used as a type here. Did you mean 'typeof key'?

然而你可以使用类型别名实现类似的重构：

  1. type key = "age";
  2. type Age = Person[key];

最后讲一个实战案例：

假设有这样一个业务场景，一个页面要用在不同的 APP 里，比如淘宝、天猫、支付宝，根据所在 APP 的不同，调用的底层 API 会不同，我们可能会这样写：

  1. const APP = ['TaoBao', 'Tmall', 'Alipay'];
  3. function getPhoto(app: string) {
  4.   // ...
  5. }
  7. getPhoto('TaoBao'); // ok
  8. getPhoto('whatever'); // ok

如果我们仅仅是对 app 约束为 string 类型，即使传入其他的字符串，也不会导致报错，我们可以使用字面量联合类型约束一下：

  1. const APP = ['TaoBao', 'Tmall', 'Alipay'];
  2. type app = 'TaoBao' | 'Tmall' | 'Alipay';
  4. function getPhoto(app: app) {
  5.   // ...
  6. }
  8. getPhoto('TaoBao'); // ok
  9. getPhoto('whatever'); // not ok

但写两遍又有些冗余，我们怎么根据一个数组获取它的所有值的字符串联合类型呢？我们就可以结合上一篇的 typeof 和本节的内容实现：

  1. const APP = ['TaoBao', 'Tmall', 'Alipay'] as const;
  2. type app = typeof APP[number];
  3. // type app = "TaoBao" | "Tmall" | "Alipay"
  5. function getPhoto(app: app) {
  6.   // ...
  7. }
  9. getPhoto('TaoBao'); // ok
  10. getPhoto('whatever'); // not ok

我们来一步步解析：

首先是使用 as const 将数组变为 readonly 的元组类型：

  1. const APP = ['TaoBao', 'Tmall', 'Alipay'] as const;
  2. // const APP: readonly ["TaoBao", "Tmall", "Alipay"]

但此时 APP 还是一个值，我们通过 typeof 获取 APP 的类型：

  1. type typeOfAPP = typeof APP;
  2. // type typeOfAPP = readonly ["TaoBao", "Tmall", "Alipay"]

最后在通过索引访问类型，获取字符串联合类型：

  1. type app = typeof APP[number];
  2. // type app = "TaoBao" | "Tmall" | "Alipay"

TypeScript 系列

  1. TypeScript 之 Narrowing
  2. TypeScript 之 More on Functions
  3. TypeScript 之 Object Type
  4. TypeScript 之 Generics
  5. TypeScript 之 Keyof Type Operator
  6. TypeScript 之 Typeof Type Operator

微信：「mqyqingfeng」，加我进冴羽唯一的读者群。

如果有错误或者不严谨的地方，请务必给予指正，十分感谢。如果喜欢或者有所启发，欢迎 star，对作者也是一种鼓励。