TypeScript 类型注释不包括基元

Question

问题： 有什么方法可以在 TypeScript 中编写类型注释，允许任何对象字面量，但不允许内置类型 number、string、boolean、Function 或 Array？

为什么？

我一直在努力改进我在工作项目中使用的一些库的相关类型定义。我在许多 JS 库中注意到的一个常见模式是传递一个用于配置库或插件的“选​​项”对象。在这些情况下，您通常会看到类似这样的类型定义：

declare module 'myModule' {
    interface IMyModule {
        (opts?: IOptions): NodeJS.ReadWriteStream;
    }
    interface IOptions {
        callback?: Function;
        readonly?: boolean;
    }
}

这允许你像这样使用它：

var myModule = require('myModule');
myModule();
myModule({});
myModule({ callback: () => {} });
myModule({ readonly: false });
myModule({ callback: () => {}, readonly: false });

这些都是有效的用例。问题是这些类型定义也允许这些无效的用例：

myModule('hello');
myModule(false);
myModule(42);
myModule(() => {});
myModule([]);

在许多情况下，上述调用会导致运行时错误，因为库 JS 代码可能会尝试在对象上设置默认值，或者将选项传递给另一个库。尽管我尝试了很多事情，但我无法将参数限制为仅接受对象而不接受任何其他无效情况。

如果你有一个只有可选成员的接口（因为不需要任何一个选项），编译器会扩大可接受的类型以接受any。

你可以在这里看到这个问题的 TypeScript Playground 演示：http://bit.ly/1Js7tLr

更新：不起作用的解决方案示例

interface IOptions {
    [name: string]: any;
    callback?: Function;
    readonly?: boolean;
}

此尝试要求对象上存在索引运算符，这意味着它现在抱怨numbers、strings、booleans、Functions 和Arrays。但这又带来了一个新问题：

var opts = {};
myModule(opts);

当它应该是一个有效的场景时，它现在失败了。 （在操场上看到这个：http://bit.ly/1MPbxfX）

Answer 1

从 TypeScript 2.2 开始，现在有一个 object 类型几乎与我上面描述的完全一样。

...除了string、boolean、number、symbol 以及使用strictNullChecks、null 和undefined 时，您可以将任何内容分配给object 类型。

在此处查看官方公告：Announcing TypeScript 2.2

Answer 2

要使接口具有合理的强制执行力，它必须至少有一个强制成员。本质上，下面的接口什么都不强制：

interface IOptions {
    callback?: Function;
    readonly?: boolean;
}

其实相当于“邪恶接口”：

interface IOptions {
}

所以你得到了自动完成，但没有真正的类型检查。

您提出的解决方案是可行的方法...

interface IOptions {
    [name: string]: any;
    callback?: Function;
    readonly?: boolean;
}

在大多数情况下，人们倾向于在函数调用中构造这些选项，但如果他们真的想在其他地方这样做，他们可以使用类型断言：

// If you must
var opts = <IOptions>{};
myModule(opts);

// More typical
myModule({});

// Although... if its empty
myModule();

免责声明。其中一小部分只是我的观点……但是空接口是 TypeScript 中使用接口所能做的最糟糕的事情，而没有强制执行的接口则是第二糟糕的事情。

您可以使用自己的基本接口来避免重复...

interface Indexed {
    [name: string]: any;
}

甚至……

interface Indexed<T> {
    [name: string]: T;
}

然后在你所有的选项界面上使用它...

interface IOptions extends Indexed {
    callback?: Function;
    readonly?: boolean;
}