@harmoniclabs/cbor

中文文档
2.1.0发布于 2026/10/27Apache-2.0TypeScriptCommonJS近 30 天下载 7.4万

cbor library for easy cbor parsing, manipulation and conversion

原始使用文档
文档目录6 节
  1. Installation
  2. Getting started
  3. How to use
  4. Cbor
  5. CborString
  6. CborObj

CBOR (Concise Binary Object Representation)

Specification

Installation

npm install @harmoniclabs/cbor

Getting started

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)

How to use

Cbor

to parse/encode CBOR you can use the Cbor static class.

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

parse allows you to go from a thing that can represent CBOR (a CborString object is always valid) to a CborObj

encode takes a CborObj and returns a CborString.

CborString

is an object that represents a valid CBOR string;

extending a ByteString includes:

  • toString method that returns a lower case hex string.
  • toBuffer method that returns the Uint8Array representation of the string.
class CborString {
    toString(): string
    toBuffer(): Uint8Array
}

CborObj

result of Cbor.parse; represents a generic CBOR tag corresponding to one of the possible Major types.

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

版本与发布记录

@harmoniclabs/cbor 共发布 25 个版本,首次发布于 2023/04/29;过去 12 个月发布了 4 个版本。

版本发布日期距今
2.1.0latest2026/10/2721 天前
2.0.22026/08/053 个月前
2.0.12026/03/108 个月前
2.0.02026/03/108 个月前
1.6.62025/03/111.7 年前
1.6.52025/02/211.7 年前

关于 @harmoniclabs/cbor 的常见问题

@harmoniclabs/cbor 是什么?

cbor library for easy cbor parsing, manipulation and conversion

如何安装 @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 和提交记录判断。