使用对象文字的键作为 Typescript 类型？

Question

我有一个对象，其中包含一些用于我的应用程序的预定义数据，这些数据存储在 const 变量中，如下所示：

const data:{[key:string]:any} =Object.freeze({
    some: 123,
    long: {"a":"b"},
    list: ["c"],
    of: "",
    arbitrary: null,
    things: 1.2,
});

该对象的键对应用程序的其余部分是已知的。考虑这个访问数据对象的函数：

function doWork(k) {
    if(!data.hasOwnProperty(k)) throw Error();
    let value = data[k];
    //...
}

这是用类似的字符串调用的

doWork("things");

我想用 Typescript 编译时检查替换无效键的运行时错误。我希望能够写作

function doWork(k: keyof data) {
    let value = data[k];
    //...
}

但显然keyof 运算符不是这样工作的。我收到一个错误TS2304: Cannot find name 'data'.

---

我的解决方法： 我可以像这样提取对象的键：

console.log("\""+Object.keys(data).join("\"|\"")+"\"");

然后我可以复制/粘贴并定义为类型。

type data_key = "some"|"long"|"list"|"of"|"arbitrary"|"things"
export function doWork(k:data_key) {
    let value = data[k];
    //...
}

这感觉像是一个愚蠢的 hack，而且每当我必须进行更改时都非常不方便，因为我必须记住将这个语句放在正确的位置，运行程序，然后手动将值复制回源代码代码（或者实际上，只需自己输入更改即可）。

---

我愿意接受更好的解决方案。是否有提供我正在寻找的功能的语言功能？

Answer 1

让 TypeScript 推断 data 的类型，然后使用 type data_key = keyof typeof data; 从它推断的类型中提取键：

const data = Object.freeze({
    some: 123,
    long: {"a":"b"},
    list: ["c"],
    of: "",
    arbitrary: null,
    things: 1.2,
});

type data_key = keyof typeof data;

function doWork(k: data_key) {
    let value = data[k];
    //...
}

On the playground.

工作原理：

1. TypeScript 具有先进的type inference，因此能够推断传递给Object.freeze 的对象初始值设定项的类型，键为some、long、list 等。Object.freeze 定义为@ 987654333@¹，因此它返回相同推断类型的 Readonly 版本。
2. keyof 获取类型的键。
3. 在这种情况下，typeof 是 TypeScript 的 typeof，而不是 JavaScript。在 TypeScript 中，有些地方需要运行时值，而其他地方需要编译时类型。 keyof 的操作数是期望编译时类型的地方，因此 typeof data 返回 data 的编译时类型，这是从 freeze 推断类型的只读版本（带有键some、long、list 等）。 （如果你有x = typeof data，那将是typeof，在需要运行时值的上下文中，所以它将是JavaScript 的typeof，而x 将获得运行时值"object"。）

¹ 实际上，lib.es5.d.ts 中的 freeze 有三种定义（一种用于数组，一种用于函数，一种用于所有其他类型的对象；这是最后一种）。