对自定义打字稿类型的内省

时间:2017-08-07 13:17:18

标签: typescript

我在typescript中定义了一个自定义类型

type MyType = 'left' | 'right';

如何检查此类型的变量匹配? 如何迭代此类型的可能值? (例如,创建相应的select元素)

3 个答案:

答案 0 :(得分:3)

在运行时添加类型信息是TypeScript的non-goal。这意味着他们不希望允许您定义类型,然后在运行时检查它。

然而,相反的情况就好了:创建一个在运行时存在的对象,并使用TypeScript来推断它的类型信息。这是你的一种方式。

首先,添加以下辅助函数:

function stringLiteralArray<T extends string>(...args: T[]): T[] {
  return args;
}

这有助于TypeScript推断出一个字符串文字数组,而不仅仅是string[]

现在,您可以创建一个名为myType的运行时对象,并从中派生MyType

const myType = stringLiteralArray('left', 'right'); // ('left'|'right')[]
type MyType = (typeof myType)[number]; // 'left' | 'right'

然后你有运行时和编译时类型信息。您可以使用以下用户定义的类型保护来检查变量是否属于该类型:

function isMyType(x: any): x is MyType {
  return myType.includes(x); // needs es2016 at least, or implement yourself
}

您可以在运行时迭代myType,并且可以在编译时在MyType上执行exhaustiveness checking

function foo(x: MyType): string { // error, not exhaustive
  switch (x) {
    case 'left': return 'L';
    case 'rihgt': return 'R'; // error, 'rihgt' isn't 'left'|'right'
  }
}

希望有所帮助。

答案 1 :(得分:2)

您不能使用&#34;简单类型&#34;,但是从Typescript 2.4开始,您可以使用包含字符串值的枚举:

enum MyType {
    LEFT='left',
    RIGHT='right'
}

for (let i in MyType) {
    console.log(MyType[i]); //will print "left" and "right"
}

它的工作原理是因为在运行时期间存在名为MyType的对象,其值为{RIGHT:'right',LEFT:'left'}

答案 2 :(得分:1)

这是不可能的。

你必须编写和使用这样的东西:

type MyType = 'left' | 'right';
const MyTypeMeta = ["left", "right"];

这个主题有an old discussion here,有很多相关问题。也许是this message的希望,但现在还没有完成。