带有 TypeScript 的 npm 模块

Question

我正在用 TypeScript 编写一个 npm 模块。假设我的图书馆中有这棵树：

.
├── README.md
├── dist
│   ├── index.d.ts
│   └── index.js
├── lib
│   └── index.ts
├── package-lock.json
├── package.json
├── test
│   └── test.js
└── tsconfig.json

在我的package.json 我有这个：

{
    "name": "mylib",
    "version": "1.0.1",
    "description": "A Node.js module",
    "main": "dist/index.js",
    "types": "dist/index.d.ts",
    "scripts": {
        "build": "tsc"
    },
    "devDependencies": {
        "typescript": "^2.5.3"
    }
}

在 tsconfig.json 中——默认配置——我有：

{
    "compilerOptions": {
        "target": "es5",
        "module": "commonjs",
        "declaration": true,
        "outDir": "./dist",
        "strict": true
    }
}

在dist/index.ts 我有：

export function appendtext(str: string): string {
    return str + ' world';
}

我把这个库称为：

var mylib = require('mylib');
var result = mylib.appendtext('Hello');

问题1：当我从我的应用程序myapp 调用mylib 时，myapp 不会构建它；它只会使用dist/ 处的编译代码。这是正确的吗？

问题2：如果1正确，那么我可以将lib/index.ts的源代码拆分成不同的模块，在开发mylib的时候用WebPack编译。生成的代码将保存在dist/，这是myapp 将使用的代码。所以，myapp 不需要编译mylib 的模块，因为它会使用dist/ 已经链接的代码。

感谢您的澄清！

Answer 1

问题 1：是的，只会运行来自 dist/ 的构建代码。

问题 2：是的，您可以将 index.ts 拆分为多个文件或模块。一般来说，你可能不想在这个级别使用 webpack - 在大多数情况下，最好留给最终的最终应用程序。这是不必要的（最终应用程序通常会使用 webpack 或类似的东西），并且会因为更难找到正在执行的“真实”代码而使调试等变得更加复杂。

相反，您可以拆分为多个文件，仍然只使用 tsc，它们将全部以 dist/ 结尾，通过内部 require() 调用链接在一起，就像任何普通节点模块一样，并且那会很好用。或者，如果您需要拆分成完全独立的模块，只需分别对每个模块遵循相同的模式，这样它们都会导出 JavaScript 文件 + 类型，您可以从下一个模块照常导入它们。