TypeScript中如何为对象键保留类型提示(无需额外类型/工具函数)
问题
先看这段代码:
type Example = { prop: string } const example = { a: { prop: "a" }, b: { prop: "b" }, c: { prop: "c" }, }
此时访问example.会有明确的类型提示,能看到a、b、c三个键。
但如果给对象标注Record<string, Example>类型,就会丢失键的类型提示:
const example: Record<string, Example> = { a: { prop: "a" }, b: { prop: "b" }, c: { prop: "c" }, }
现在访问example.不会再提示a、b、c,因为键被宽泛定义成了string。
请问怎么替代Record<string, Example>,既能把值的类型约束为Example,又能保留对象已定义的键的类型提示,而且不需要额外定义单独类型或工具函数?
解决方案
方法1:用satisfies关键字(TypeScript 4.9+)
直接在对象定义后加satisfies Record<string, Example>,它会检查对象值是否符合Example类型,但不会改变对象键的字面量类型推导,因此能保留类型提示:
type Example = { prop: string } const example = { a: { prop: "a" }, b: { prop: "b" }, c: { prop: "c" }, } satisfies Record<string, Example>; // 访问example.依然能看到a、b、c的提示,且值不符合Example时会报错
方法2:类型断言(兼容低版本TS)
如果你的TS版本低于4.9,可以用类型断言结合typeof来约束值类型,同时保留键的字面量类型:
type Example = { prop: string } const example = { a: { prop: "a" }, b: { prop: "b" }, c: { prop: "c" }, } as { [K in keyof typeof example]: Example };
补充说明
两种方法都不需要额外定义单独的键类型或工具函数,直接在对象定义时完成约束,同时保留原始的键提示。satisfies是更简洁推荐的写法,只要TS版本支持就优先用它。
内容的提问来源于stack exchange,提问作者myol
相关产品推荐
相关产品推荐

