为什么TypeScript访问索引签名对象的不存在键时,值类型不推断为string|undefined?
为什么TypeScript默认不将索引取值推断为
string | undefined 这个行为是TypeScript出于兼容性做的长期设计决策,核心逻辑如下:
- 你定义的
{ [key: string]: string }属于字符串索引签名,在TS的默认语义里,这个签名表示对该对象传入任意字符串键,都能稳定返回一个string类型的值 - 这个设计是为了兼容大量存量JavaScript的使用习惯:很多开发者会用普通对象作为字典存储结构,通过工程约定保证所有被读取的键都会被提前赋值,不需要每次读取都做空校验。如果TS默认就给所有索引取值加上
undefined的可能性,这类约定下的代码会被要求增加大量冗余的空值判断,提升不必要的类型检查成本。 - 这个和运行时行为不一致的推断逻辑,是TS长期被开发者诟病的设计点之一,但出于不破坏存量项目兼容性的考虑,哪怕是全量开启
strict严格模式,该校验选项也不会被自动打开,需要手动配置。
如何强制TypeScript实现
string | undefined的类型推断 有两种常用的实现方式,可以根据项目的配置偏好选择:
方案1:开启全局编译配置
在项目的tsconfig.json的compilerOptions字段中,添加配置"noUncheckedIndexedAccess": true即可:
{ "compilerOptions": { "noUncheckedIndexedAccess": true } }
- 该配置开启后,所有通过索引签名取值、数组按下标取值的操作,TS都会自动把返回值类型和
undefined做联合,完全对齐运行时的真实行为。你示例中的b变量,类型会被自动推断为string | undefined。
方案2:显式声明索引签名的返回类型
如果不想修改全局编译配置,可以在定义索引类型的时候,显式把返回值定义为包含undefined的联合类型:
const example: { [key: string]: string | undefined } = { a: 'abc' }
- 这种显式类型声明的优先级高于TS的默认推断逻辑,无论编译配置如何设置,通过任意字符串键读取
example的属性时,TS都会把取值的类型标记为string | undefined。
内容的提问来源于stack exchange,提问作者Max Yankov
相关产品推荐
相关产品推荐

