如何将模型与模块一起导出?

时间:2017-12-22 10:01:31

标签: node.js typescript typescript-typings

我正在编写一个模块,为我们的团队正在使用的测试套件添加一些功能。它是一个包含主要打字稿文件的项目,它包装了我们项目的其他导出。

index.d.ts:

export * from "./OneModule"
export * from "./AnotherModule"

其中一个模块具有向Chai.js断言库添加新方法的功能。这是通过使用它的函数来添加新方法来实现的,例如:

assertion.addChainableMethod('newMethod', callback, chainCallback)

将添加编写expect(something).to.be.newMethod()等语句的功能。但是,TypeScript并不能识别这些新方法,因为@types/chai中的断言类型显然没有这些功能。

我已经创建了与Chai Assertion合并的接口定义,如下所示:

declare namespace Chai {
    interface Assertion {
        newMethod(something: string): Assertion;
        newMethod: Assertion;
    }
}

addChainableMethod添加了新方法,因此它也可以链接为expect(something).to.be.newMethod.equals(),这就是必须将其定义为属性和方法的原因。

问题是,无论我如何将上述声明添加到index.d.ts,新的断言在导入项目中都不可见。我怀疑它以某种方式包装在模块命名空间中(但我可能会非常错误)。我知道我可以做@types/newAssertions并在那里定义它们,但这要求用户在package.json中包含2个项目,并且还要求我们的开发人员一次处理2个项目。如何导出我的Chai命名空间扩展和我拥有的所有模块?

我能做的最好的事情就是这样:

declare module 'my-module' {
    function AddNewAssertions(chai: any, utils: any): void;
}
declare namespace Chai {
    interface Assertion { //same as above }
}

但是有了这个,我无法公开我的其他模块,只有当我只暴露AddNewAssertions函数时才会有效,这会添加这些断言。这很完美。

1 个答案:

答案 0 :(得分:1)

我为此敲了一个非常基本的测试应用程序,并且我在添加时取得了一些成功:

declare global {
    namespace Chai {
        interface Assertion {
            newMethod(something: string): Assertion;
            newMethod: Assertion;
        }
    }
}

这使得扩展在您的其他模块中可见,而不仅仅是具有声明的模块。