# @harmoniclabs/cbor 中文文档

规范地址：https://npmcn.com/package/%40harmoniclabs/cbor/

版本：2\.1\.0
npm 元数据更新时间：2026-10-26T17:38:38.903Z
中文译文更新时间：2026-11-17T09:57:23.759Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：132 kB，76 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2023-04-29T14:12:00.263Z
- 最新版本发布：2026-10-26T17:38:38.530Z
- 近 30 天下载量：73574（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 4 个）

## 中文简介

cbor 库,用于简单剖析、操作和转换

## 安装

```sh
npm install @harmoniclabs/cbor
```

也可以使用：`pnpm add @harmoniclabs/cbor`、`yarn add @harmoniclabs/cbor`、`bun add @harmoniclabs/cbor`

## README

# CBOR (简明二进制对象表示)

[规格](https://datatracker.ietf.org/doc/html/rfc7049)

## 安装

```bash
npm install @harmoniclabs/cbor
```

## 开始

```ts
import { Cbor, CborText } from "@harmoniclabs/cbor";

const input = "6B68656C6C6F20776F726C64";

const cborObj = Cbor.parse( input );

if( cborObj instanceof CborText )
{
    console.log( cborObj.text ) // prints "hello world"
}

const encoded = Cbor.encode( cborObj ).toString();

console.log( encoded ) // prints "6b68656c6c6f20776f726c64" (lower case hex)

```

## 如何使用

### `Cbor`

以解析/编码 CMOR 可使用 `Cbor` 静态类.

```ts
export declare class Cbor {
    private constructor();
    static encode(cborObj: CborObj): CborString;
    static parse(cbor: CborString | Uint8Array | string): CborObj;
}
```

`parse` 允许您从一个能够代表 ComBOR 的东西( a) `CborString` 对象总是有效的)到 a `CborObj`

`encode` 使用一个 `CborObj` 返回 a `CborString`。 。 。 .

### `CborString`

是一个代表有效 COBOR 字符串的对象;

扩展 a [`ByteString`](https://github.com/HarmonicLabs/bytestring) 包括:

-   `toString` 返回小写十六进制字符串的方法.
-   `toBuffer` 返回 `Uint8Array` 表示字符串.

```ts
class CborString {
    toString(): string
    toBuffer(): Uint8Array
}
```

### `CborObj`

结果 `Cbor.parse`; 代表与可能的主要类型之一相对应的通用 CBOR 标记.

```ts
type CborObj
    = CborNegInt
    | CborUInt
    | CborBytes
    | CborText
    | CborArray
    | CborMap
    | CborTag
    | CborSimple;
```

## 常见问题

### @harmoniclabs/cbor 是什么？

cbor 库,用于简单剖析、操作和转换

### 如何安装 @harmoniclabs/cbor？

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

### @harmoniclabs/cbor 支持 TypeScript 吗？

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

### @harmoniclabs/cbor 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @harmoniclabs/cbor 可以商用吗？

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

### @harmoniclabs/cbor 的下载量有多少？

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

### @harmoniclabs/cbor 还在维护吗？

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

