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（TypeScript中的exports = function...）中的唯一功能时，我遇到了问题。在这种情况下，导出的函数有点像匿名＆＃39;并且甚至没有在d.ts文件中命名，所以我需要手动编辑它。

我的测试用例：

＆＃39;我的封装＆＃39;提供单一功能，通常导入为＆＃39; myPackage＆＃39;：

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

在tsconfig.json中将

declaration设置为true，因此tsc命令生成了my-package.d.ts文件：

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

我的包应该在我的项目中使用：

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

但是，即使将myPackage复制到typings文件夹中，tsc仍无法找到my-package.d.ts。我需要编辑该文件，使其如下所示：

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文件（reference）中添加对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');

Answer 3

从TypeScript 1.6开始，您可以从package.json引用类型定义文件，TypeScript的模块分辨率应该能够挖掘出类型定义。

在你的package.json文件中（你的本地npm模块），添加一个“typings”条目，例如

{
    "name": "my-package",
    "typings": "./relative/path/to/my-package.d.ts"
}

这样你根本不需要操纵TSD。

请参阅TypeScript Wiki：https://github.com/Microsoft/TypeScript/wiki/Typings-for-npm-packages

tsd：安装本地定义文件

3 个答案: