自动将 Typescript 定义文件包装在模块中

Question

我很可能在这里遗漏了一些 tsconfig 选项。

我做的很简单：

我正在创建一个 npm 模块，例如：

export class HelloWorld {
    constructor(public greeting: string){}
}

我的 tsconfig 是：

{
  "compilerOptions": {
    "target": "ES5",
    "module": "commonjs",
    "removeComments": true,
    "noImplicitAny": false,
    "preserveConstEnums": true,
    "declaration": true,
    "suppressImplicitAnyIndexErrors": true,
    "outDir": "../js"
  },
  "filesGlob": [
    "./**/*.ts",
    "!./node_modules/**/*.ts"
  ]
}

当我的声明被自动创建时，它看起来像这样：

export declare class HelloWorld {
    greeting: string;
    constructor(greeting: string);
}

但是在其他项目中实际安装 npm 包时，这并不好用。当我导入我必须使用的包时：

import hello = require("hello-world/js/index");

（例如）

我发现当我将声明文件包装在模块declare module "hello-world" {...}中时，我可以根据import hello = require("hello-world");的需要导入它

手动包装生成的定义文件不是一个选项，因为它一直在重写自己，是否有任何选项可以从 package.json 获取包的名称并自动将定义包装在该模块中？

Answer 1

确保您在package.json 中指定了typings 属性...

{
    "name": "hello-world",
    "typings": "hello-world.d.ts",
    ...etc...
}

...或将您的定义文件更改为index.d.ts。

那么在安装完这些改动的包后，编译器就可以在你写的时候解析了：

import hello = require("hello-world");

More details