tsd:安装本地定义文件

Question

我有一个用TypeScript编写的本地节点包,我想在实际项目中使用它.使用npm,我可以像这样安装本地包:

$ npm install --save /path/to/package

要么:

$ npm install --save /path/to/package.tar.gz

这将在node_modules目录中安装所需的.js文件.在该包中还有一个生成的.d.ts文件,我想将其安装到我的项目中(在typings/tsd.d.ts中自动链接它).但使用以下命令无效:

$ tsd install /path/to/package/package.d.ts --save

它说>> zero results.那么,在不需要存储库的情况下安装本地定义文件的方法是什么？

更新:

我可以简单地将我的d.ts文件复制到typings目录和我的文本编辑器(对我来说,它是使用TypeScript插件的Sublime Text),它能够找到声明.目录布局是这样的:

/my-project/
  /typings/
    tsd.d.ts - auto-generated by `tsd install`
    node/ - I've installed the node definitions
    my-package.d.ts - copied or symlinked file
  my-project.ts - I'm working here

但是,在module.exports(exports = function...在TypeScript中)导出唯一的函数时,我遇到了一个问题.在这种情况下,导出的函数有点'匿名',甚至在d.ts文件中都没有命名,因此我需要手动编辑它.

我的测试用例:

'my-package'提供了一个函数,通常导入为'myPackage':

export = function myPackage(a: string, b: string) { return a + ' ' + b; };

declarationtrue在tsconfig.json中设置为,所以该tsc命令生成了my-package.d.ts文件:

declare var _default: (a: string, b: string) => string;
export = _default;

我的包应该在我的项目中像这样使用:

import myPackage = require('my-package');
myPackage('foo', 'bar');

但是,myPackage即使my-package.d.ts被复制到typings文件夹中,tsc也找不到.我需要编辑该文件,使其看起来像这样:

declare var myPackage: (a: string, b: string) => string;
//export = _default; - not needed

或者更好的正确运作require():

declare module 'my-package' /* this is the string passed to require() */ {
    export = function(a: string, b: string): string;
}

Answer 1

即使package.json的技巧有效,我也更喜欢为此制作的工具(tsd或typings).

我刚刚找到了打字的答案:
typings install --save --ambient file:./node_modules/.../file.d.ts

我觉得和tsd一样:)

编辑:
因为TypeScript 2.0打字是没用的.
赶紧跑npm i --save-dev @types/some-library

Answer 2

在本地节点包中,添加一个typescript > definition条目package.json:

{
  "name": "your-package",
  ...
  "typescript": {
    "definition": "package.d.ts"
  }
}

然后在项目中安装包后,运行命令...

tsd link

...将package.d.ts在项目的tsd.d.ts文件中添加引用(引用).

此外,根据您的编辑,我建议您将定义文件更改为这样的(注意引号my-package):

declare module "my-package" {
    function myPackage(a: string, b: string): string;
    export = myPackage;
}

这将使它与以下代码一起使用:

import myPackage = require('my-package');
myPackage('foo', 'bar');