类型脚本:对象和基元之间的联合的keyof typeof永远不会

时间:2018-09-07 11:24:59

标签: typescript types type-conversion type-inference

首先,我的问题涉及到一些上下文:我有一个项目,该项目通过Socket.IO接收对象,因此没有关于它的类型信息。此外,它是一种相当复杂的类型,因此需要进行大量检查以确保接收到的数据良好。

问题是我需要访问由接收对象中的字符串指定的本地对象的属性。对于第一维来说,这行得通,因为我可以将任何类型的属性说明符强制转换为keyof typeof(无论我要访问的是什么类型)(例如this.property[<keyof typeof this.property> data.property])。

结果变量的类型显然是一个相当长的联合类型(将this.property具有的所有属性的所有类型组合在一起)。一旦这些属性之一是非原始类型,keyof typeof subproperty就会被推断为never

通过之前进行的检查,我可以保证该属性存在,并且我99%的确定代码一旦编译就可以运行。只是编译器在抱怨。

下面是一些非常简单的代码,可重现此行为以及观察到的类型和预期的类型。

const str = 'hi';
const obj = {};
const complexObj = {
    name: 'complexObject',
    innerObj: {
        name: 'InnerObject',
    },
};

let strUnion: typeof str | string;              // type: string
let objUnion: typeof obj | string;              // type: string | {}
let complexUnion: typeof complexObj | string;   // type: string | { ... as expected ... }

let strTyped: keyof typeof str;                 // type: number | "toString" | "charAt" | ...
let objTyped: keyof typeof obj;                 // type: never (which makes sense as there are no keys)
let complexObjTyped: keyof typeof complexObj;   // type: "name" | "innerObject"

let strUnionTyped: keyof typeof strUnion;       // type: number | "toString" | ...
let objUnionTyped: keyof typeof objUnion;       // type: never (expected: number | "toString" | ... (same as string))
let complexUnionTyped: keyof typeof complexUnion;   // type: never (expected: "name" | "innerObject" | number | "toString" | ... and all the rest of the string properties ...)
let manuallyComplexUnionTyped: keyof string | { name: string, innerObj: { name: string }};  // type: number | "toString" | ... (works as expected)

这是TypeScript(版本3)的已知限制吗?还是我在这里缺少什么?

1 个答案:

答案 0 :(得分:3)

如果有一个联合,则只能访问公共属性。 keyof将为您提供一种可公开访问的密钥。

对于strUnionTypedstring和字符串文字类型'hi'之间的联合,结果类型将具有与string相同的属性,因为联合中的两种类型具有与字符串。

对于objUnionTypedcomplexUnionTyped,并集没有公共密钥,因此结果将是never

对于manuallyComplexUnionTyped,您将获得string的密钥,因为您写的实际上是(keyof string) | { name: string, innerObj: { name: string }}而不是keyof (string | { name: string, innerObj: { name: string }}),因此您在{与您指定的对象类型结合。

要获取联合的所有成员的键,可以使用条件类型:

string

修改

条件类型有助于获取所有并集成员键的原因是因为条件类型distribute优于裸类型参数。因此,在我们的情况下

type AllUnionMemberKeys<T> = T extends any ? keyof T : never;
let objUnionTyped: AllUnionMemberKeys<typeof objUnion>;
let complexUnionTyped: AllUnionMemberKeys<typeof complexUnion>;