angular 库的 DefinitelyTyped 与 index.d.ts
DefinitelyTyped vs index.d.ts for angular library
我为 angular 1.x 创建了一个带有单元测试助手的简单库:https://github.com/dakolech/angular-unit-testing-helpers
现在我想添加类型定义。我的问题是:
我应该在我的存储库中创建 index.d.ts
文件还是应该在 DefinitelyTyped
存储库中创建新文件夹?
如果首先,那么如何导入此文件中的 angular 类型(例如 ng.IScope
)?
如果可能,首选方法是将类型包含在 NPM 包中并在 package.json 中指定它们的位置。
您需要在您的项目中包含 [something].d.ts 文件,将 "typings" 属性 添加到您的 package.json 引用它,然后发布它你的代码到 NPM。
有关此的官方文档,请参阅 https://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html。
如果您的项目依赖于 NPM 包中没有包含类型的任何类型,这会变得更加复杂。有关详细信息,请参阅 https://github.com/typings/typings/blob/master/docs/faq.md#should-i-use-the-typings-field-in-packagejson。你想包含一个 typings.json 文件,它指定如何通过 Typings 获取你的依赖关系,然后告诉你的用户 运行 typings install npm:your-page
,这将给他们你的类型定义和所有typings.json.
中的相关定义
我为 angular 1.x 创建了一个带有单元测试助手的简单库:https://github.com/dakolech/angular-unit-testing-helpers
现在我想添加类型定义。我的问题是:
我应该在我的存储库中创建 index.d.ts
文件还是应该在 DefinitelyTyped
存储库中创建新文件夹?
如果首先,那么如何导入此文件中的 angular 类型(例如 ng.IScope
)?
如果可能,首选方法是将类型包含在 NPM 包中并在 package.json 中指定它们的位置。
您需要在您的项目中包含 [something].d.ts 文件,将 "typings" 属性 添加到您的 package.json 引用它,然后发布它你的代码到 NPM。
有关此的官方文档,请参阅 https://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html。
如果您的项目依赖于 NPM 包中没有包含类型的任何类型,这会变得更加复杂。有关详细信息,请参阅 https://github.com/typings/typings/blob/master/docs/faq.md#should-i-use-the-typings-field-in-packagejson。你想包含一个 typings.json 文件,它指定如何通过 Typings 获取你的依赖关系,然后告诉你的用户 运行 typings install npm:your-page
,这将给他们你的类型定义和所有typings.json.