打字稿“树”对象定义

时间:2018-08-13 15:18:16

标签: typescript definition

我不太确定要创建的对象类型的“名称”。我称它为树是因为它看起来类似于没有关系的嵌套树。本质上,我想要一个具有这样嵌套定义的对象

{
    test1: OptionsInterface,
    test2: {
        test3: OptionsInterface,
        test4: {
            test5: OptionsInterface,
        },
    },
}

因此,第一层可以是OptionsInterface{[s: string]: OptionsInterface},是否可以在对象的每个“层”上使用它?

我尝试过这样定义上面的内容:

export default class ApiClient {
    constructor(options: {[s: string]: OptionsInterface | {[s: string]: OptionsInterface}}) {}

但这仅是2深度吧?有没有一种方法可以定义示例对象而无需手动添加每个深度?

用例

我希望能够像这样呼叫我的班级

api = new ApiClient(routeSchema);
await api.call('test2.test4.test5', params);

通话中:

async call(config: string, variables: object = {}): Promise<Response> {
  const options = get(this.configuration, config);

  if (options === undefined) {
    throw new ConfigNotDefinedExpection(config);
  }

  return await this.callWithOptions(options, variables);
}

callWithOptions期望OptionsInterface的地方

1 个答案:

答案 0 :(得分:3)

当然可以。

type NestableOptionsInterface = OptionsInterface | { [k: string]: NestableOptionsInterface }

这表示NestableOptionsInterfaceOptionsInterface或字典,其键是您想要的任何键,其值是NestedOptionsInterface。因此,这是一个递归定义。让我们测试一下:

class Foo {
  constructor(options: NestableOptionsInterface) { }
}

declare const optionsInterface: OptionsInterface;

new Foo(optionsInterface); // okay
new Foo({ a: optionsInterface, b: { c: optionsInterface } }); // okay
new Foo({ a: { b: { c: { d: { e: optionsInterface } } } } }); // okay
new Foo("whoops"); // error
new Foo({ a: optionsInterface, b: { c: "whoops" } }); // error

看起来不错。

如果您想维护实际构造函数参数的类型,则可以使用如下泛型:

class Foo<O extends NestableOptionsInterface> {
  constructor(options: O) { }
}

declare const optionsInterface: OptionsInterface;

new Foo(optionsInterface); // Foo<OptionsInterface>
new Foo({ a: optionsInterface, b: { c: optionsInterface } }); // Foo<{ a: OptionsInterface, b:{c: OptionsInterface}}>
new Foo({ a: { b: { c: { d: { e: optionsInterface } } } } }); // Foo<{ a:{b:{c:{d:{e: OptionsInterface}}}}}>

希望有帮助。祝你好运!