这是一个用 TypeScript 编写的示例节点module：https : //github.com/basarat/ts-npm-module

这是一个使用此示例module的示例 TypeScript 项目https://github.com/basarat/ts-npm-module-consume

基本上你需要：

• 用commonjs和编译declaration:true
• 生成.d.ts文件

接着

• 让您的 ide 读取生成的.d.ts.

Atom-TypeScript 只是提供了一个很好的工作流程：https : //github.com/TypeStrong/atom-typescript#packagejson-support

对于 TypeScript 4.x、TypeScript 3.x 或 TypeScript 2.x，以下步骤描述了使用 TypeScript 创建库（npm 包）必须执行的操作：

• 像往常一样创建您的项目（包括测试和所有内容）
• 添加declaration: true到tsconfig.json以生成类型。
• 通过一个导出 API index.ts
• 在 中package.json，指向您生成的类型。例如，如果您outDir是dist，则将其添加"types": "dist/index.d.ts"到您的包 json 中。
• 在 中package.json，指向您的主入口文件。例如，如果您outDir是dist并且主入口文件是index.js，则添加"main": "dist/index.js"到您的 package.json 中。
• 在 中package.json，将您要发送到 npm: 的文件列入白名单files: ["/dist"]。另一种方法是使用 将其列入黑名单.npmignore，但很难保持最新状态。
• 发布到 npm npm publish。使用 semver 规范进行更新（补丁/错误修复npm version patch、非破坏性添加、破坏性npm version minorAPI 更改npm version major）

因为它让我一个同时通过所有过期的资源在互联网上关于这个主题（如一个在此页...）进行筛选，我决定把它包起来如何到写A-typescript库与最新的工作最小示例。

这是使用 TypeScript 1.8.10 的最新答案：

我的项目结构是：

|
|--- src
|--- test
|--- dist     <= My gulp file compiles and places the js, sourcemaps and .d.ts files here
|      |--- src
|      |--- test
|--- typings
.gitignore
.npmignore
gulpfile.js
package.json
README.md
tsconfig.json
tslint.json
typings.json

我添加了以下内容.npmignore以避免包含无关文件并保持最低限度让包导入和工作：

node_modules/
*.log
*.tgz

src/
test/
gulpfile.js
tsconfig.json
tslint.json
typings.json
typings
dist/test

我的.gitignore有：

typings

# ignore .js.map files
*.js.map
*.js
dist

我的package.json有：

"main": "dist/src/index.js",
"typings":  "dist/src/index.d.ts",

现在我运行： npm pack

生成的文件（解压缩时）具有以下结构：

|
|--- dist
|       |--- src
|              |
|              index.js
|              index.js.map
|              index.d.ts
|
package.json
README.md

现在我转到我想将其用作库的项目并键入： npm install ./project-1.0.0.tgz

它安装成功。

现在我index.ts在我刚刚安装了 npm 的项目中 创建了一个文件 import Project = require("project");

打字Project.给了我智能感知选项，这是整个练习的重点。

希望这有助于其他人在他们的大型项目中使用他们的 TypeScript npm 项目作为内部库。

PS：我相信这种将项目编译为可用于其他项目的npmmodule的方法让人联想.dll到.NET世界上的。我可以想象在 VS Code 中的解决方案中组织项目，其中每个项目生成一个 npm 包，然后可以在解决方案中的另一个项目中作为依赖项使用。

由于我花了相当长的时间才弄明白这一点，所以我把它贴出来以防有人卡在这里。

我还在以下位置发布了一个已关闭的错误：https : //github.com/npm/npm/issues/11546

这个例子已经上传到Github：vchatterji/tsc-seed

您应该发布原始typescript源而不是类型定义。在package.json让“类型”属性指向*的.ts文件。

*.d.ts 对现有的 JS 库进行注释是很好的，但作为消费者，我宁愿阅读typescript代码，也不愿在类型定义和下层生成的 JS 代码之间切换。

我主要遵循Varun Chatterji的建议

但是，我想展示一个带有单元测试和代码覆盖率的完整示例，npm并使用javascript或typescript

该module是使用编写的，typescript 2.2并且在将其发布到 npm 之前配置prepublish钩子以编译使用的代码很重要tsc

https://github.com/sweetim/haversine-position

https://www.npmjs.com/package/haversine-position