typescript - 创建和使用 TypeScript 库的故事是什么？

Question

我一直在 Web 应用程序中到处使用 TypeScript，并引用了通过 Definitely Typed 提供的公共(public)类型定义。但我一直想不通的一件事是，如何在 TypeScript 中创建可重用的库，以供 TypeScript 应用程序或其他库使用。

关于该主题的大多数指南似乎直接指向如何为最初用 JavaScript 编写的库创建或查找类型定义，但是用 TypeScript 编写的库呢，似乎有一些共享生成的 js 文件和相应类型的机制定义文件应该是常见的地方，但我还没有找到任何人试图为私有(private)或公共(public)图书馆这样做。也许我找错地方了？有没有关于创建和使用 TypeScript 库的故事。

Answer 1

要创建将由 TS 项目使用的 TS 库，您不必做很多事情。

(抱歉，如果示例过于冗长。)

图书馆

假设您的源文件是用 TypeScript 编写的，您需要进行以下配置调整:

tsconfig.json

{
  "compilerOptions": {
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "target": "es5",
    "module": "commonjs",
    "removeComments": false,
    "sourceMap": true,
    "outDir": "dist/",
    "declaration": true
  },
  "filesGlob": [
    "**/*.ts",
    "!node_modules/**/*"
  ],
  "exclude": [
    "node_modules",
    "typings/global",
    "typings/global.d.ts"
  ],
  "compileOnSave": true
}

这里重要的基本上是 declarations: true，它告诉 TS 编译器生成 d.ts 文件。

package.json

{
  "name": "my-typescript-library",
  "description": "...",
  "version": "1.0.0",
  "main": "./dist/my.service.js",
  "typings": "./dist/my.service.d.ts",
  "license": "ISC",
  "dependencies": {
    ...
  },
  "devDependencies": {
    "typescript": "^1.8.10",
    "typings":"^1.0.4",
    ...
  }
}

这里重要的是“main”和“typings”，它们是库中服务的入口点。因此，如果有人要 require("my-typescript-library") 那么将使用此处列出的文件。 typings 字段类似，但显然有助于 TypeScript。

然后您将这个库推送到 Github、Bitbucket 或任何地方。

消费者

这里你不需要太多。

package.json

向你的库添加一个依赖:

{
  ...,
  "dependencies": {
    "my-typescript-library": "git+ssh://bitbucket.org/you/my-typescript-library",
    ...
  }
}

在此示例中，您将需要一个 SSH key 。

然后您只需导入库即可。

我的文件.ts

import {MyService} from "my-typescript-library";

至此，TypeScript 应用程序中使用了一个 TypeScript 库。希望这足以回答(并且足够清楚)，否则请给我留言。