Typescript为具有动态和静态键的对象创建接口

Question

我正在尝试学习 typescript，但在接口方面遇到了困难，我有一个对象，我想保存一个 token 和一个 route，如下所示

const obj = {
  token: 'thisismytoken',
  '/path/to/somewhere': [{ ... }]
}

我遇到的问题是：如何为这个对象生成接口？

我试过了：

interface iObject {
  token: string;
  [key: string]: { ... }[]
}

但这会产生错误：

TS2411：“字符串”类型的属性“令牌”不可分配给字符串索引类型“{ ... }”。

当我尝试类似的事情时会发生同样的事情：

interface iRoute {
  val1: number;
  val2: string;
}

interface iObject extends iRoute {
  token: string;
}

当我尝试类似：

interface iObject {
  [key: string]: { ... }[] | string;
}

当我尝试向路由变量添加数据时出现以下错误：

TS2339：“字符串 | 类型”上不存在属性“推送” { ... }[]'。
类型“字符串”上不存在属性“推送”。

还有其他方法可以做到这一点吗？

Answer 1

你可以做这样的事情。您正在尝试创建字典，因此这可能会有所帮助。

要有一个干净的代码

第一种方法

interface IDictionary<T> {
    [key: string]: T;
}

interface iObject {
    token: string;
    route: IDictionary<any[]>;
}

//Use it like this
var obj: iObject = {
            token: "thisismytoken",
            route: {
                "/path/to/somewhere": [{
                    pathName: 'somewhere'
                }]
            }
        };

这是working typescript playground

第二种方法基于您上次的尝试

当我尝试类似：

接口 iObject { [key: string]: { ... }[] |细绳; }

    interface IDictionary<T> {
        [key: string]: T;
    }

    var obj: IDictionary<any> = {
            token: "asdf123",
            "path/to/somewhere": [{
                data: 'something'
            }]
        };

TS2339：“字符串”类型上不存在属性“推送”| { ... }[]'。 类型“字符串”上不存在属性“推送”。

第三种方法

你可以像这样对你的 obj 进行类型转换

interface iObject {
  [key: string]: Array<object> | string;
}

self.obj = {
            token: self.tokenVal
        };
        self.obj[self.route] = [{ "routeName": self.routeName }];

        (<Array<object>>self.obj[self.route]).push({
            "zip": "123456"
        });

另请参阅Advanced Types

Answer 2

您可以为此使用交集类型：

type iObject = {
    token: string
} & {
    [key: string]: { ... }[]
}

但请注意，索引类型不会将您限制为一个属性。您可能需要的是经过正则表达式验证的密钥，might come in the future。