使用类创建模块化 TypeScript 库

Question

我有一个 Web API 我想为其构建一个库，这样我就不需要在我正在与这个 API 交谈的每个新项目中编写相同的代码。

我也想拆分我的代码，所以我为每个端点结构都有一个 class ，所以，例如，假设我有多个用户端点，它们执行类似的操作

• 登记
• 登录

我会有一个 UserClient 提供两种方法

export default class UserClient
{
    register(email: string, password: string)
    {
        // code here
    }

    login(email: string, password: string, remember: bool)
    {
        // code here
    }
}

所以，我像这样构建了我的代码

package.json
tsconfig.json
--src
----api
------user-client.ts
----models
------user
--------logindata.ts

我的 tsconfig.json 看起来像这样

{
  "compilerOptions": {
    "declaration": true,
    "declarationDir": "./dist",
    "module": "commonjs",
    "noImplicitAny": true,
    "lib": ["es2017", "es7", "es6", "dom"],
    "outDir": "./dist",
    "target": "es2015",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true
  },
  "typedocOptions": {
    "mode": "modules",
    "out": "docs"
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules",
    "dist"
  ]
}

和我的 package.json

{
  "name": "xxx",
  "version": "1.0.0",
  "description": "xxx",
  "main": "dist/index.js",
  "types": "dist/index.d.ts", 
  "files": [
    "/dist"
  ],
  "repository": "xxx",
  "author": "xxx",
  "license": "MIT",
  "private": true,
  "scripts": {
    "build": "tsc",
    "prepare": "npm run build",
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}

所以我已经看到的是我说我的主要是 dist/index.js 类型是 dist/index.d.ts 而我没有索引文件

所以我有多个问题

• 我需要 src 中的 index.ts 吗？ 如果是的话，里面会有什么？
• 我需要将类型更改为其他类型吗？

我基本上想为我创建的每个 class 输入类型，然后在另一个库中使用它

import {UserClient} from "myLib"
import {BooksClient} from "myLib"

但是，当我现在使用tsc构建库时，它不会创建 index.d.ts（因为我没有 index.ts），而只会创建user-client.js和user-client.d.ts直接在 dist 文件夹中（不考虑现有结构），我也不能在我的其他库中使用它们

Answer 1

好的，所以我修好了。 首先，我们需要的是，客户端将被导出

所以user-client.ts应该是这样的

export class UserClient
{
    // code
}

然后，我在你的 index.ts 中缺少（或做错了）你需要导出而不是导入客户端

export {UserClient} from "./api/user-client"

然后，我使用tsc命令构建了我的文件，然后在我的消费库中，我能够使用npm link../jsapi然后简单地使用

import {UserClient} from 'jsapi'

没有任何问题。

我使用本教程作为帮助： https://www.tsmean.com/articles/how-to-write-a-typescript-library/但必须实际查看他们的https://github.com/bersling/typescript -library-starter/blob/master/library-starter/src/index.ts得到正确答案