在Typescript 界面中使用保留关键字作为属性

发布于05月09日

我想定义一个typescript interface，将答案从web服务映射到一个类型(类似于图here所示).下面是一个例子.

{
    "type": "Seen",
    "creation": 33,
    "fileId": 6
}

因此，以下接口将是合适的.

interface Event {
    type: 'Accepted' | 'Judgment' | 'Seen';
    creation: number;
    fileId: number;
}

不幸的是，编译器不喜欢它:type是一个保留关键字.

如何在接口中使用保留关键字作为属性？

我想可以使用另一个术语定义属性，然后以某种方式定义它的别名，如建议的here，或使用var代替建议的here，但在我的例子中，我找不到该怎么做.

推荐答案

在interface中使用名为type的属性是完全正确的.实际上，您可以在界面中使用TypeScript的所有关键字:

interface Test {
  type: string
  class: string
  any: string
}

这里的问题是，您正在修改existing interface，它已经将type定义为string类型:

// lib.dom.d.ts
/** An event which takes place in the DOM. */
interface Event {
  readonly type: string;
  /* ... */
}

可以使用相同的名称定义多个接口来合并它们.这被称为"Declaration Merging".但如果使用不同的类型定义相同的属性，则会出现以下错误:

"type"的所有声明必须具有相同的修饰符.

因此，除非您试图修改全局可用的接口Event，否则您应该 Select 接口的另一个名称.