typescript 中的索引签名类型

索引签名的背景

在 TypeScript 中，索引签名用于定义对象具有动态键时的类型。它允许我们定义一个对象，其属性是任意数量的，且属性键为某种特定类型（如字符串或数字）。

索引签名的语法

索引签名使用方括号和类型注解来定义：

1
2
3
interface Example {
  [key: string]: number;
}
  • key: 表示对象中的键，通常为 string 或 number 类型。
  • number: 表示对象中的值的类型。

使用场景

  • 动态属性：对于具有未知数量和名称的属性，可以使用索引签名。
  • 灵活性：允许定义灵活的数据结构，如配置项、字典等。

示例代码

1
2
3
4
5
6
7
8
9
10
11
12
13
interface StringNumberDictionary {
  [key: string]: number;
}

const scores: StringNumberDictionary = {
  Alice: 10,
  Bob: 15,
};

// 错误示例
// const wrongScores: StringNumberDictionary = {
//   Alice: "ten", // Error: Type 'string' is not assignable to type 'number'.
// };

注意点

  • 所有具体属性必须符合索引签名的类型限制。如果有其他具体属性，它们也必须符合指定值的类型。

与普通接口对比

特性 普通接口 索引签名
属性数量 固定数量 任意数量
属性名称 固定名称 动态名称
类型限制 各属性可不同 所有同一类型
灵活性 较低 较高

原因及适用场景

在设计需要灵活数据结构、配置文件或 API 响应等情况下，通常无法预知所有可能的键。此时，索引签名提供了一种更加动态和宽松的方法来处理这些数据。