# @exodus/serialization 中文文档

规范地址：https://npmcn.com/package/%40exodus/serialization/

版本：2\.3\.3
npm 元数据更新时间：2026-10-13T17:14:06.215Z
中文译文更新时间：2026-11-14T03:57:24.521Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40exodus/serialization
原文对照：https://npmcn.com/package/%40exodus/serialization/?lang=original
项目主页：https://github.com/ExodusMovement/exodus/tree/master/libs/libraries/serialization
源码仓库：https://github.com/ExodusMovement/exodus

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

- 包体积（解压后）：12.9 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2023-04-05T19:01:39.477Z
- 最新版本发布：2026-10-13T17:14:06.039Z
- 近 30 天下载量：49850（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 3 个）

## 中文简介

JSON 出院常用课程的序列化/去序化

## 安装

```sh
npm install @exodus/serialization
```

也可以使用：`pnpm add @exodus/serialization`、`yarn add @exodus/serialization`、`bun add @exodus/serialization`

## README

# @ exodus/ 序列化

将数据进行序列化和去序列化,例如用于传输电线. 支持数组, `Date`, (中文(简体) ), `Buffer`, (中文(简体) ), `Uint8Array`, (中文(简体) ), `BigInt` 以及随自定义类型扩展的能力.

## 安装

```sh
pnpm add @exodus/serialization
```

## 使用量

### 香草

```js
import createSerializeDeserialize from '@exodus/serialization'

const { serialize, deserialize } = createSerializeDeserialize()

const original = { hello: Buffer.from('world') }
const fromOverTheWire = deserialize(serialize(original))
expect(fromOverTheWire).toEqual(original)
```

### 自定义类型

要添加自己的类型,请提供包含以下内容的类型定义:

-   `type`(单位:千美元) **独一无二** 类型字符串标识符
-   `test`: 返回函数 `true` 如果该值是类型实例
-   `serialize`: 序列化类型值的函数
-   `deserialize`: 使类型值去序列化的函数

例如,如果 `BigInt` 序列化不是内置的,你可以添加如下支持:

```js
const { serialize, deserialize } = createSerializeDeserialize([
  {
    type: 'bigint',
    test: (v) => typeof v === 'bigint',
    serialize: (v) => v.toString(),
    deserialize: (v) => BigInt(v),
  },
])

const original = {
  question: 'what is the biggest number in the universe?',
  answer: BigInt(42),
}

const fromOverTheWire = deserialize(serialize(original))
expect(fromOverTheWire).toEqual(original)
```

## 常见问题

### @exodus/serialization 是什么？

JSON 出院常用课程的序列化/去序化

### 如何安装 @exodus/serialization？

在项目目录运行 npm install @exodus/serialization，或使用 pnpm add / yarn add / bun add。

### @exodus/serialization 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/exodus\_\_serialization 是否存在。

### @exodus/serialization 支持 ESM 还是 CommonJS？

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

### @exodus/serialization 可以商用吗？

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

### @exodus/serialization 的下载量有多少？

根据 npm 官方下载统计，@exodus/serialization 在 2026/10/14 – 2026/11/12 这 30 天内被下载 49,850 次，日均约 1,662 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @exodus/serialization 还在维护吗？

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