@ deessejs/ errors (英语)

轻量级,类型安全的错误处理,用于TypeScript——Python风格. 基于函数的API,例外连锁,分级继承,和丰富的出错语义. 仅限无害环境管理,为一级互操作性设计 @deessejs/fp'结果并尝试.

兄弟姐妹项目: @deessejs/fp 提供 Result 财务报告和审定财务报表 Try 本地融合类型 @deessejs/errors 错误工厂。 将它们安装在一起,以获得一个没有胶合码的完整错误处理故事.

包含的内容

安装

npm install @deessejs/errors

@deessejs/fp 是可选的 - 如果您想要作曲, 请安装它 Result编号 :Try 类型 ErrorInstance。 。 。 .

使用量

import { z } from 'zod';
import { error, raise, is, causes } from '@deessejs/errors';

// Define a factory with a Standard Schema. The `message` is a
// function that receives the schema's *output* (post-transform).
// The factory's call signature requires the schema's *input*,
// so callers can supply the validated shape directly.
const ValidationError = error({
  name: 'ValidationError',
  fields: z.object({
    field: z.string(),
    reason: z.string(),
  }),
  message: (data) => `Field "${data.field}" is invalid: ${data.reason}`,
});

// Construct a typed error. The schema validates the input.
const err = ValidationError({ field: 'email', reason: 'invalid format' });
// err.message === 'Field "email" is invalid: invalid format'

// Chain a cause. .from() replaces the previous cause; the
// previous cause is reachable through its own .cause link.
const cause = error({ name: 'NetworkError' })();
err.from(cause);

// Throw it
raise(err);

// Later, type-check and walk the chain
is(err, ValidationError); // true
causes(err); // [cause]

为什么这个图书馆

• 默认很简单. 没有阶级等级,没有装饰者在反省之中.
• 仅限无害环境管理. 现代包装,没有CJS shim,没有 module编号 :main 重叠.
• 最小运行时间. 唯一的运行时间依赖是 @standard-schema/spec。 。 。 .
• 类型脚本一等. 严格类型, 不 any 出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出入出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出入出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出 JSDoc在每个公共符号上.
• 真正的测试. 具有类型级和运行时间测试的活性测试,包括因子链转录.

引擎兼容性

仅限无害环境管理。 使用 CJS 解析器的消费者需要使用动态 import() 或迁移到无害环境管理.

可用命令

捐款

打开一个问题来讨论更大的变化. 对于打字,断开的链接和小修正,公关是受欢迎的.

在提交公关前:

1. 运行 pnpm test:run 财务报告和审定财务报表 pnpm lint。 。 。 .
2. 添加一个 .changeset/<topic>.md 如果更改是用户化的(patch / small / major) .
3. 更新 docs/internal/product/README.md 如果 API 表面改变.

许可证

麻省理工学院。详情见LICENSE文件.

鸣谢

README 版式基于 解剖/包装-模版 并借用其结构 中学/小学,适合 @deessejs/errors API表面.