The error codes management tool library maintained by Buka Inc.
npm install @buka/error-codes结构化错误码管理库,提供 64 位结构化错误码的编码、解码和管理能力。
``bash`
pnpm add @buka/error-codes
npm install @buka/error-codes
yarn add @buka/error-codes
`typescript
import { ErrorCode, ErrorCategory } from "@buka/error-codes";
const errorCode = new ErrorCode({
category: ErrorCategory.BUSINESS, // 错误类别
systemId: 1, // 系统 ID
moduleId: 100, // 模块 ID
sequenceId: 42, // 序列号
});
`
`typescript
// 转换为可读格式字符串
const readable = errorCode.toString(); // B0-AAAC-AAAB-AAA
// 转换为 64 位整数
const bigint = errorCode.toBigInt();
// 从可读格式解析
const parsed = ErrorCode.fromString("B0-AAAC-AAAB-AAA");
`
ErrorCategory 枚举提供以下错误类别:
- ErrorCategory.AUTH (10) - 认证与安全ErrorCategory.BUSINESS
- (11) - 业务逻辑异常ErrorCategory.CONFLICT
- (12) - 数据冲突ErrorCategory.DEGRADE
- (13) - 功能降级/熔断ErrorCategory.FEATURE
- (15) - 功能不可用ErrorCategory.RATE_LIMIT
- (24) - 流量限制ErrorCategory.SYSTEM
- (25) - 系统故障ErrorCategory.THIRD_PARTY
- (26) - 第三方服务异常ErrorCategory.VALIDATION` (27) - 参数校验错误
-
详细说明见规范文档。
详见 docs/specification.md 了解完整的错误码规范设计、位段划分、编码规则、错误类别定义和保留错误码说明。