await-to-js 项目使用教程

1. 项目的目录结构及介绍

await-to-js/
├── LICENSE
├── README.md
├── package.json
├── src/
│   └── index.ts
└── tsconfig.json

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件，包含项目的元数据和依赖项。
• src/: 源代码目录。
  • index.ts: 项目的主文件，包含核心功能的实现。
• tsconfig.json: TypeScript 配置文件，用于编译 TypeScript 代码。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，该文件定义了 await-to-js 的核心功能，即提供一个方便的方法来处理异步操作中的错误。以下是该文件的主要内容：

export function to<T, U = Error>(
  promise: Promise<T>,
  errorExt?: object
): Promise<[U, undefined] | [null, T]> {
  return promise
    .then<[null, T]>((data: T) => [null, data])
    .catch<[U, undefined]>((err: U) => {
      if (errorExt) {
        const parsedError = Object.assign({}, err, errorExt);
        return [parsedError, undefined];
      }
      return [err, undefined];
    });
}

export default to;

该函数接受一个 Promise 和一个可选的错误扩展对象，返回一个包含错误和结果的数组。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖项，以下是该文件的主要内容：

{
  "name": "await-to-js",
  "version": "3.0.0",
  "description": "Async/await wrapper for easy error handling in js",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/scopsy/await-to-js.git"
  },
  "keywords": [
    "async",
    "await",
    "error",
    "handling",
    "promise"
  ],
  "author": "Dmitriy Mozgovoy <[e-mail]>",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/scopsy/await-to-js/issues"
  },
  "homepage": "https://github.com/scopsy/await-to-js#readme",
  "devDependencies": {
    "@types/jest": "^26.0.20",
    "jest": "^26.6.3",
    "ts-jest": "^26.5.1",
    "typescript": "^4.1.3"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的主入口文件。
• types: TypeScript 类型定义文件。
• scripts: 包含项目的构建和测试脚本。
• repository: 项目的代码仓库地址。
• keywords: 项目的关键词。
• author: 项目作者。
• license: 项目许可证。
• bugs: 项目问题跟踪地址。
• homepage: 项目主页。
• devDependencies: 开发依赖项。

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，用于编译 TypeScript 代码，以下是该文件的主要内容：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true