# @aklinker1/zero-serialize-error 中文文档

规范地址：https://npmcn.com/package/%40aklinker1/zero-serialize-error/

版本：1\.0\.2
npm 元数据更新时间：2026-05-14T04:53:26.013Z
中文译文更新时间：2026-11-05T17:32:39.906Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aklinker1/zero-serialize-error
原文对照：https://npmcn.com/package/%40aklinker1/zero-serialize-error/?lang=original
项目主页：https://github.com/aklinker1/zero-serialize-error#readme
源码仓库：https://github.com/aklinker1/zero-serialize-error

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.1 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-14T02:42:25.261Z
- 最新版本发布：2026-05-14T04:53:25.718Z
- 近 30 天下载量：273785（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

以零依赖性对错误进行序列化和去序列化

## 安装

```sh
npm install @aklinker1/zero-serialize-error
```

也可以使用：`pnpm add @aklinker1/zero-serialize-error`、`yarn add @aklinker1/zero-serialize-error`、`bun add @aklinker1/zero-serialize-error`

## README

# `@aklinker1/zero-serialize-error`

[![JSR](https://jsr.io/badges/@aklinker1/zero-serialize-error)](https://jsr.io/@aklinker1/zero-serialize-error) [![NPM Version](https://img.shields.io/npm/v/%40aklinker1%2Fzero-serialize-error?logo=npm&labelColor=red&color=white)](https://www.npmjs.com/package/@aklinker1/zero-serialize-error) [![API Reference](https://img.shields.io/badge/API%20Reference-blue?logo=readme&logoColor=white)](https://jsr.io/@aklinker1/zero-serialize-error/doc) [![License](https://img.shields.io/npm/l/%40aklinker1%2Fzero-serialize-error)](https://github.com/aklinker1/zero-serialize-error/blob/main/LICENSE)

以零依赖性对错误进行序列化和去序列化.

```sh
bun add @aklinker1/zero-serialize-error
```

## 特征

-   将错误转换为或从 JS 对象转换
-   整个序列化 `cause` 树
-   QQ 支持自定义属性添加到错误中
-   QQ 接受自定义序列化函数, 用于将其他数据类型转换为对象或从对象转换
-   零依赖性小包

## 使用量

```ts
const error = Error("🐛");

const serialized = serializeError(error);
console.log(serialized); // { name: "Error", message: "🐛", stack: "..." }

const deserialized = deserializeError(serialized);
console.log(deserialized); // Error: 🐛
```

### 其他数据类型

其他类别除外 `Error`s在序列化/去序化时被默认支持 :

```ts
const error = new Error("With a date");
error.time = new Date();

const serialized = serializeError(error);
console.log(serialized); // { ..., time: "[object Date]" }

const deserialized = deserializeError(serialized);
console.log(deserialized.time); // "[object Date]"
```

* * *

灵感来自 `serialize-error`目标是缩小其范围,减少任何依赖,使其尽可能小.

| 软件包 | 大小 | `node_modules` 大小 |
| --- | :-: | :-: |
| `serialize-error` | 20千贝 | 586.8千贝 |
| `@aklinker1/zero-serialize-error` | 6.1千贝 | 6.1千贝 |

## 常见问题

### @aklinker1/zero-serialize-error 是什么？

以零依赖性对错误进行序列化和去序列化

### 如何安装 @aklinker1/zero-serialize-error？

在项目目录运行 npm install @aklinker1/zero-serialize-error，或使用 pnpm add / yarn add / bun add。

### @aklinker1/zero-serialize-error 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aklinker1/zero-serialize-error 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aklinker1/zero-serialize-error 可以商用吗？

@aklinker1/zero-serialize-error 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aklinker1/zero-serialize-error 的下载量有多少？

根据 npm 官方下载统计，@aklinker1/zero-serialize-error 在 2026/10/06 – 2026/11/04 这 30 天内被下载 273,785 次，日均约 9,126 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aklinker1/zero-serialize-error 还在维护吗？

最新版本 1\.0\.2 发布于 2026/05/14（5 个月前）；至今共发布 3 个版本，其中过去 12 个月发布了 3 个；首次发布于 2026/05/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。