使用 Object.entries() 时保留键类型

Question

这是我的问题的一个示例 (demo in ts playground)

type Tkey = 'foo' | 'bar' | 'defaultKey'

const typedObject: Record<Tkey, Boolean> = {
  'foo': true,
  'bar': false,
  'defaultKey': true
}

// type does not persist string narrowing
const entries = Object.entries(typedObject) // [string, Boolean][]

所以[key, values] 中的key 是string 类型，而不是Tkey 类型。

作为一种解决方法，您可以事后手动强制，但最好在操作期间定义类型。

const typedEntries = entries as [Tkey, Boolean][]

Answer 1

您可以通过添加您自己的对象定义来扩展default typescript lib，该对象定义接受两个泛型类型参数。

在您的项目根目录中添加以下globals.d.ts 文件：

interface ObjectConstructor {
    entries<TKey extends PropertyKey, TVal>(o: Record<TKey,TVal>): [TKey, TVal][];
    keys<TKey extends PropertyKey>(obj: Record<TKey,any>): TKey[];
}

然后像这样使用它：

const entries = Object.entries<ObjKeys, Boolean>(myObj) // [ObjKeys, Boolean][]
const keys = Object.keys<ObjKeys>(myObj) // ObjKeys[]

Demo in TS Playground

Answer 2

TypeScript 的原生定义文件包含 Object.entries:

entries<T>(o: { [s: string]: T } | ArrayLike<T>): [string, T][];

entries(o: {}): [string, any][];

您获得所需行为的唯一机会是使用以下内容覆盖此定义：

interface YourOwnObject {
  entries<T>(o: { [K in keyof T]: T[K] }): [keyof T, T[keyof T]][];
}

(<YourOwnObject>Object).entries(typedObject).forEach(([key, values]) => {
  // ...
})