乐趣区

关于javascript:说说我对-TypeScript-索引签名-理解

jiezi

作者：Dmitri Pavlutin
译者：前端小智
起源：dmitripvlutin

有幻想，有干货，微信搜寻 【大迁世界】 关注这个在凌晨还在刷碗的刷碗智。

本文 GitHub https://github.com/qq449245884/xiaozhi 已收录，有一线大厂面试残缺考点、材料以及我的系列文章。

咱们用两个对象来形容两个码农的工资：

const salary1 = {
  baseSalary: 100_000,
  yearlyBonus: 20_000
};
 
const salary2 = {contractSalary: 110_000};

而后写一个获取总工资的函数

function totalSalary(salaryObject: ???) {
  let total = 0;
  for (const name in salaryObject) {total += salaryObject[name];
  }
  return total;
}
totalSalary(salary1); // => 120_000
totalSalary(salary2); // => 110_000

如果是你的，要如何申明 totalSalary() 函数的 salaryObject 参数，以承受具备字符串键和数字值的对象？

答案是应用一个索引签名!

接着，咱们来看看什么是 TypeScript 索引签名以及何时须要它们。

1. 什么是索引签名

索引签名 的思维是在只晓得键和值类型的状况下对构造未知的对象进行类型划分。

它完全符合 salary 参数的状况，因为函数应该承受不同构造的 salary 对象，惟一的要求是属性值为数字。

咱们用索引签名来申明 salaryObject 参数

function totalSalary(salaryObject: { [key: string]: number }) {
  let total = 0;
  for (const name in salaryObject) {total += salaryObject[name];
  }
  return total;
}
 
totalSalary(salary1); // => 120_000
totalSalary(salary2); // => 110_000

{[key: string]: number} 是索引签名，它通知 TypeScript salaryObject 必须是一个以string 类型为键，以 number 类型为值的对象。

2. 索引签名语法

索引签名的语法相当简略，看起来与属性的语法类似，但有一点不同。咱们只需在方括号内写上键的类型，而不是属性名称：{[key: KeyType]: ValueType }。

上面是一些索引签名的例子。

string 类型是键和值。

interface StringByString {[key: string]: string;
}
 
const heroesInBooks: StringByString = {
  'Gunslinger': '前端小智',
  'Jack Torrance': '王大志'
};

string 类型是键，值能够是 string、number或boolean

interface Options {[key: string]: string | number | boolean;
  timeout: number;
}
 
const options: Options = {
  timeout: 1000,
  timeoutMessage: 'The request timed out!',
  isFileUpload: false
};

签名的键只能是一个 string`、number或 symbol`。其余类型是不容许的。

3. 索引签名的注意事项

TypeScript 中的索引签名有一些注意事项，须要留神。

3.1 不存在的属性

如果试图拜访一个索引签名为 {[key: string]: string } 的对象的一个不存在的属性，会产生什么？

正如预期的那样，TypeScript 将值的类型推断为 string。然而查看运行时值，它是undefined:

依据 TypeScript 提醒, value 变量是一个 string 类型，然而它的运行时值是 undefined。

索引签名只是将一个键类型映射到一个值类型，仅此而已。如果没有使这种映射正确，值类型可能会偏离理论的运行时数据类型。

为了使输出更精确，将索引值标记为 string 或 undefined。这样，TypeScript 就会意识到你拜访的属性可能不存在

3.2 string 和 number 键

假如有一个数字名称的字典:

interface NumbersNames {[key: string]: string
}
 
const names: NumbersNames = {
  '1': 'one',
  '2': 'two',
  '3': 'three',
  // ...
};

通过字符串键拜访值与预期统一:

如果用数字 1 拜访一个值会出错吗?

不会，失常工作。

当在属性拜访器中作为键应用时，JavaScript 隐式地将数字强制为字符串 (names[1] 与names['1']雷同)。TypeScript 也会执行这个强制。

你能够认为 [key: string] 与 [key: string | number] 雷同。

4. 索引签名与 Record<Keys, Type>比照

TypeScript 有一个实用类型 Record<Keys, Type>，相似于索引签名。

const object1: Record<string, string> = {prop: 'Value'}; // OK
const object2: {[key: string]: string } = {prop: 'Value'}; // OK

那问题来了 … 什么时候应用 Record<Keys, Type>，什么时候应用 索引签名？乍一看，它们看起来很类似

咱们晓得，索引签名只承受 string、number 或 symbol 作为键类型。如果你试图在索引签名中应用，例如，字符串字面类型的联结作为键，这是一个谬误。

索引签名在键方面是通用的。

然而咱们能够应用字符串字面值的联结来形容 Record<keys, Type>中的键

type Salary = Record<'yearlySalary'|'yearlyBonus', number>
 
const salary1: Salary = { 
  'yearlySalary': 120_000,
  'yearlyBonus': 10_000
}; // OK

Record<Keys, Type> 是为了具体到键的问题。

倡议应用索引签名来正文通用对象，例如，键是字符串类型。然而，当你当时晓得键的时候，应用 Record<Keys, Type> 来正文特定的对象，例如字符串字面量 'prop1' | 'prop2' 被用于键值。

总结

如果你不晓得你要解决的对象构造，但你晓得可能的键和值类型，那么索引签名就是你须要的。

索引签名由方括号中的索引名称及其类型组成，前面是冒号和值类型：{[indexName: KeyType]: ValueType }，KeyType 能够是一个 string、number 或 symbol，而ValueType 能够是任何类型。

~~ 完，我是刷碗智，写到这海贼王最新一画《天王山》更新了超级刺激，我要去追了，咱们下期见！

编辑中可能存在的 bug 没法实时晓得，预先为了解决这些 bug, 花了大量的工夫进行 log 调试，这边顺便给大家举荐一个好用的 BUG 监控工具 Fundebug。

原谅：https://dmitripavutin.com/typ…

交换

文章每周继续更新，能够微信搜寻 【大迁世界】 第一工夫浏览，回复 【福利】 有多份前端视频等着你，本文 GitHub https://github.com/qq449245884/xiaozhi 曾经收录，欢送 Star。

退出移动版