@automate.ax/codec

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

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

安装

bun add @automate.ax/codec

使用量

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。 。 。 .