@ruijie-sso/exception-tools/README.md

exception-tools library for SSO Admin

# exception-tools

对异常处理工具集

## 错误码处理

针对只有错误码换 `message` 的情况

原理是通过 js 生成每一个错误码的 json 文件，再通过统一的 service 来动态获取每一种 code 对应的 message

### 为什么这么设计

- 错误码未来分中英文
- 错误码无法预知它只会在那个模块出现
- 后端会保证每种错误码对应一个 message
- 未来错误码可能变成接口，数据存放在数据库中

### 新增错误码

- 修改文件路径 `tools/error-code/build.ts`
- 在 errorCodes 里添加相关错误码

```ts
const errorCodes: { [key: string]: string } = {
  你的错误码: '错误码message'
};
```

- 执行 `按升序排列行` 保证顺序为了好管理
  - 选中所有 code
  - command+shift+p（mac vscode）
  - 输入 sort 关键词
  - 选中`按升序排列行`

执行 `yarn run:tools tools/error-code/build.ts` 即可实时更新错误码 json 文件

### 项目中使用

- 使用 `pipe` errorCode 做转换
- 使用 `service` ErrorCodeService 做数据请求