# @glow-xyz/beet 中文文档

规范地址：https://npmcn.com/package/%40glow-xyz/beet/

版本：0\.6\.0
npm 元数据更新时间：2022-08-27T15:47:39.001Z
中文译文更新时间：2026-11-16T16:24:39.006Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：187 kB，63 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-07-03T17:43:04.777Z
- 最新版本发布：2022-08-27T15:47:38.913Z
- 近 30 天下载量：5737（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

严格的 Borsh 兼容脱/序列器

## 安装

```sh
npm install @glow-xyz/beet
```

也可以使用：`pnpm add @glow-xyz/beet`、`yarn add @glow-xyz/beet`、`bun add @glow-xyz/beet`

## README

# @glow-xyz/蜂窝

严格的borsh相容的去/序列器.

**目录** _生成方式 [DocTOC 文档](https://github.com/thlorenz/doctoc)_

-   [特征](https://npmcn.com/package/%40glow-xyz/beet/#readme-features)
-   [固定大小对动态类型](https://npmcn.com/package/%40glow-xyz/beet/#readme-fixed-size-vs-dynamic-types)
-   [API 密码](https://npmcn.com/package/%40glow-xyz/beet/#readme-api)
-   [实例](https://npmcn.com/package/%40glow-xyz/beet/#readme-examples)
    -   [单一固定 Struct 配置](https://npmcn.com/package/%40glow-xyz/beet/#readme-single-fixed-struct-configuration)
    -   [单一可修复 Struct 配置](https://npmcn.com/package/%40glow-xyz/beet/#readme-single-fixable-struct-configuration)
    -   [嵌入式 Struct 配置](https://npmcn.com/package/%40glow-xyz/beet/#readme-nested-struct-configuration)
    -   [以非原始字段显示](https://npmcn.com/package/%40glow-xyz/beet/#readme-struct-with-non-primitive-fields)
    -   [直接使用甜菜原创](https://npmcn.com/package/%40glow-xyz/beet/#readme-using-beet-primitives-directly)
        -   [固定大小](https://npmcn.com/package/%40glow-xyz/beet/#readme-fixed-size)
        -   [动态大小](https://npmcn.com/package/%40glow-xyz/beet/#readme-dynamic-size)
    -   [直接使用甜菜复合剂](https://npmcn.com/package/%40glow-xyz/beet/#readme-using-beet-composites-directly)
        -   [选项](https://npmcn.com/package/%40glow-xyz/beet/#readme-option)
        -   [阵列](https://npmcn.com/package/%40glow-xyz/beet/#readme-array)
            -   [统一固定大小](https://npmcn.com/package/%40glow-xyz/beet/#readme-uniform-fixed-size)
            -   [动态大小](https://npmcn.com/package/%40glow-xyz/beet/#readme-dynamic-size-1)
        -   [带有数据变量的 Enum](https://npmcn.com/package/%40glow-xyz/beet/#readme-enum-with-data-variants)
-   [自由主义](https://npmcn.com/package/%40glow-xyz/beet/#readme-license)

## 特征

-   完全可调和,即:. `coption(array(utf8String))` 已处理 正确的
-   结构可以被嵌入并组成
-   预计算 `byteSize` 无论巢穴多深或多深
-   仅通过提供值或序列化将非固定类型转换为固定版本 数据
-   固定大小和 _可修复_ 结构显示相同的序列化/去序列化API并进行 需要时在引擎盖下转换
-   日志结构配置,包括字节大小以及易于解/串行的任务 诊断

```
beet:debug struct GameStruct {
beet:debug   win: u8 1 B
beet:debug   totalWin: u16 2 B
beet:debug   whaleAccount: u128 16 B
beet:debug   losses: i32 4 B
beet:debug } 23 B +0ms
beet:trace serializing [GameStruct] _GameScore { win: 1, totalWin: 100, whaleAccount: <BN: fffffffffffffffffffffffffffffffb>, losses: -234 } to 23 bytes buffer +0ms
beet:trace deserializing [GameStruct] from 23 bytes buffer +2ms
beet:trace <Buffer 01 64 00 fb ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 16 ff ff ff> +0ms
beet:trace [
beet:trace     1, 100,   0, 251, 255, 255,
beet:trace   255, 255, 255, 255, 255, 255,
beet:trace   255, 255, 255, 255, 255, 255,
beet:trace   255,  22, 255, 255, 255
beet:trace ] +0ms
```

## 固定大小对动态类型

甜菜已经优化了 _已固定_ 类型,因为这可以记录关于 它正在处理的数据结构以及避免缓冲器调整大小.

仅 _甜点_ 已经 _已固定_ 在名称是固定的大小, 所有其他都是 _可修复_ 类型 暴露 `toFixedFromData` 财务报告和审定财务报表 `toFixedFromValue` 转换为a的方法 _固定甜菜_ 从 序列数据或数值.

甜菜提供 `FixableBeetStruct` 将具有非固定大小字段的参数去/序列化.

因此,甜菜执行整个 [波斯光谱](https://borsh.io/)但是,如果你想要一个图书馆 直接使用其中一种替代品,即:. [波斯语](https://github.com/near/borsh-js)。 。 。 .

## API 密码

请找到 [API 文件在这里](https://metaplex-foundation.github.io/beet/docs/beet)。 。 。 .

## 实例

### 单一固定 Struct 配置

```ts
import { BeetStruct, i32, u16, u8 } from '@metaplex-foundation/beet'

class Result {
  constructor(
    readonly win: number,
    readonly totalWin: number,
    readonly losses: number
  ) {}

  static readonly struct = new BeetStruct<Result>(
    [
      ['win', u8],
      ['totalWin', u16],
      ['losses', i32],
    ],
    (args) => new Result(args.win!, args.totalWin!, args.losses!),
    'Results'
  )
}
```

### 单一可修复 Struct 配置

```ts
import { FixableBeetStruct, i32, u16, u8, array } from '@metaplex-foundation/beet'

class Result {
  constructor(
    readonly win: number,
    readonly totalWin: number,
    readonly losses: number[]
  ) {}

  static readonly struct = new FixableBeetStruct<Result>(
    [
      ['win', u8],
      ['totalWin', u16],
      ['losses', array(i32)],
    ],
    (args) => new Result(args.win!, args.totalWin!, args.losses!),
    'Results'
  )
}
```

### 嵌入式 Struct 配置

**注:** 用途 `Result` 从上述例子中得出: `results` 领域 `Trader`

```ts
import { BeetStruct, fixedSizeUtf8String } from '@metaplex-foundation/beet'
class Trader {
  constructor(
    readonly name: string,
    readonly results: Results,
    readonly age: number
  ) {}

  static readonly struct = new BeetStruct<Trader>(
    [
      ['name', fixedSizeUtf8String(4)],
      ['results', Results.struct],
      ['age', u8],
    ],
    (args) => new Trader(args.name!, args.results!, args.age!),
    'Trader'
  )
}
  
const trader = new Trader('bob ', new Results(20, 1200, -455), 22)
const [buf] = Trader.struct.serialize(trader)
const [deserializedTrader] = Trader.struct.deserialize(buf)
```

### 直接使用甜菜原创

#### 固定大小

```ts
import { u8 } from '@metaplex-foundation/beet'
const n = 1
const buf = Buffer.alloc(u8.byteSize)
u8.write(buf, 0, n)
u8.read(buf, 0) // === 1
```

#### 动态大小

```ts
import { u8, array } from '@metaplex-foundation/beet'
const xs = [ 1, 2 ]
const beet = array(u8)
const fixedBeet = beet.toFixedFromValue(xs)
const buf = Buffer.alloc(fixedBeet.byteSize)
fixedBeet.write(buf, 0, xs)
fixedBeet.read(buf, 0) // === [ 1, 2 ]
```

### 直接使用甜菜复合剂

**注:** 使用情况 `Result` 从上述例子中划出一个 _复合_ 类型

#### 选项

**注:** 关于 `coption` 是一个 _可修复_ 甜菜,因为它的大小不同 _有点_ 文选. 页:1 _无_ 案例.

```ts
const resultOption: Beet<COption<Result>> = coption(Result.struct)

const result = new Result(20, 1200, -455)
const fixedBeet = resultOption.toFixedFromValue(result)

const buf = Buffer.alloc(fixedBeet.byteSize)
fixedBeet.write(buf, 0, result)
beet.read(buf, 0) // same  as result
```

#### 阵列

##### 统一固定大小

```ts
const resultArray: Beet<Array<Result>> = uniformFixedSizeArray(Result.struct, 3)
const results =[ new Result(20, 1200, -455), new Result(3, 999, 0), new Result(30, 100, -3) ]
const buf = Buffer.alloc(resultArray.byteSize)
beet.write(buf, 0, results)
beet.read(buf, 0) // same  as results
```

##### 动态大小

```ts
const resultArray: Beet<Array<Result>> = array(Result.struct)
const results =[ new Result(20, 1200, -455), new Result(3, 999, 0), new Result(30, 100, -3) ]
const fixedBeet = resultsArray.toFixedFromValue(results)

const buf = Buffer.alloc(fixedBeet.byteSize)
fixedBeet.write(buf, 0, results)
fixedBeet.read(buf, 0) // same  as results
```

## 常见问题

### @glow-xyz/beet 是什么？

严格的 Borsh 兼容脱/序列器

### 如何安装 @glow-xyz/beet？

在项目目录运行 npm install @glow-xyz/beet，或使用 pnpm add / yarn add / bun add。

### @glow-xyz/beet 支持 TypeScript 吗？

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

### @glow-xyz/beet 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @glow-xyz/beet 可以商用吗？

@glow-xyz/beet 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @glow-xyz/beet 的下载量有多少？

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

### @glow-xyz/beet 还在维护吗？

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

