# @automate\.ax/codec 中文文档

规范地址：https://npmcn.com/package/%40automate.ax/codec/

版本：0\.165\.0
npm 元数据更新时间：2026-10-28T18:00:39.631Z
中文译文更新时间：2026-11-07T06:48:53.992Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40automate.ax/codec
原文对照：https://npmcn.com/package/%40automate.ax/codec/?lang=original
项目主页：https://docs.automate.ax/

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

- 包体积（解压后）：78 kB，36 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-07-29T20:52:01.494Z
- 最新版本发布：2026-10-28T18:00:39.428Z
- 近 30 天下载量：2978（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：300（近 12 个月 300 个）

## 中文简介

基于 Msgpack 的 Automate.ax 运行时数据编码帮助器 .

## 安装

```sh
npm install @automate.ax/codec
```

也可以使用：`pnpm add @automate.ax/codec`、`yarn add @automate.ax/codec`、`bun add @automate.ax/codec`

## README

# `@automate.ax/codec`

基于 Msgpack 的 Automate.ax 运行时数据编码帮助器 .

此软件包拥有共享 `Encodable` 用于自动化信号和存储边界的价值合同。 大多数应用作者不应该直接需要它.

## 安装

```bash
bun add @automate.ax/codec
```

## 使用量

```ts
import { decode, encodableSchema, encode } from "@automate.ax/codec"

const bytes = await encode({
  message: "hello",
  createdAt: new Date(),
})

const value = await decode(bytes)
const validated = encodableSchema.parse(value)
```

## API 密码

-   `encode(value)` ——对照支持的输入表面检查一个未知值,然后序列化.
-   `decode(bytes)` ——去序列化 msgpack 字节并返回 `Encodable`。 。 。 .
-   `encodableSchema` ——Zod schema,用于对照所支持的输入表面验证未知值.
-   `isEncodable(value)` ——支持输入表面的运行时守护.
-   `Encodable` ——编码器接受的递归型.

## 支持的数值

`Encodable` 包括原始物、阵列、平地物体、, `Map`, (中文(简体) ), `Set`, (中文(简体) ), `Date`, (中文(简体) ), `RegExp`,键入数组, `ArrayBuffer`, (中文(简体) ), `DataView`,以及诸如 `Request`, (中文(简体) ), `Response`, (中文(简体) ), `Blob`, (中文(简体) ), `File`, (中文(简体) ), `Headers`, (中文(简体) ), `URL`,以及 `URLSearchParams`。 。 。 .

## 常见问题

### @automate\.ax/codec 是什么？

基于 Msgpack 的 Automate\.ax 运行时数据编码帮助器 \.

### 如何安装 @automate\.ax/codec？

在项目目录运行 npm install @automate\.ax/codec，或使用 pnpm add / yarn add / bun add。

### @automate\.ax/codec 支持 TypeScript 吗？

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

### @automate\.ax/codec 支持 ESM 还是 CommonJS？

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

### @automate\.ax/codec 可以商用吗？

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

### @automate\.ax/codec 的下载量有多少？

根据 npm 官方下载统计，@automate\.ax/codec 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,978 次，日均约 99 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @automate\.ax/codec 还在维护吗？

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