# @digitalbazaar/cborld 中文文档

规范地址：https://npmcn.com/package/%40digitalbazaar/cborld/

版本：8\.1\.0
npm 元数据更新时间：2026-04-28T19:33:30.909Z
中文译文更新时间：2026-11-12T08:42:33.360Z
软件包许可：BSD-3-Clause

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

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

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

- 包体积（解压后）：99 kB，39 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：6 个
- 首次发布：2020-07-23T19:35:15.756Z
- 最新版本发布：2026-04-28T19:33:30.734Z
- 近 30 天下载量：10489（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 1 个）

## 中文简介

用于Javascript的 CBOR-LD 编码器/解码器.

## 安装

```sh
npm install @digitalbazaar/cborld
```

也可以使用：`pnpm add @digitalbazaar/cborld`、`yarn add @digitalbazaar/cborld`、`bun add @digitalbazaar/cborld`

## README

# JavaScript CMOR- LD 处理器

[![Build Status](https://img.shields.io/github/actions/workflow/status/digitalbazaar/cborld/main.yaml)](https://github.com/digitalbazaar/cborld/actions/workflows/main.yaml) [![Coverage Status](https://img.shields.io/codecov/c/github/digitalbazaar/cborld)](https://codecov.io/gh/digitalbazaar/cborld)

> 一个用于Web浏览器和Node.js应用程序的JavaScript CBOR-LD进程.

## 目录

-   [背景情况](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-background)
-   [安装](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-install)
-   [使用量](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-usage)
-   [API 密码](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-api)
-   [贡献](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-contribute)
-   [商业支助](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-commercial-support)
-   [许可证](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-license)

## 背景情况

此库为 Web 浏览器和 Node.js 提供 CBOR- LD 处理器 应用.

## 安装

该软件需要并支持维持的最近版本的Node.js和 浏览器. 更新可能会去除对旧的未维护的平台版本的支持. 请使用依赖性版本锁文件和测试以确保兼容性 与这个软件.

### 国家预防机制

```
npm install @digitalbazaar/cborld
```

### 图形

在当地安装(用于开发):

```
git clone https://github.com/digitalbazaar/cborld.git
cd cborld
npm install
```

## 使用量

此库提供了编码和解码的两种主要功能 CBOR-LD数据.

### 编码为 CBOR- LD

要将 JSON- LD 文档编码为 CBOR- LD :

```js
import {encode} from '@digitalbazaar/cborld';

const jsonldDocument = {
  '@context': 'https://www.w3.org/ns/activitystreams',
  type: 'Note',
  summary: 'CBOR-LD',
  content: 'CBOR-LD is awesome!'
};

// encode a JSON-LD Javascript object into CBOR-LD bytes
// Note: user must provide their own JSON-LD `documentLoader`
const cborldBytes = await encode({
  jsonldDocument,
  documentLoader,
  // use standard compression (set to `0` to use no compression)
  registryEntryId: 1
});
```

要将 CBOR-LD 文档解码为 JSON- LD :

```js
import {decode} from '@digitalbazaar/cborld';

// get the CBOR-LD bytes
const cborldBytes = await fs.promises.readFile('out.cborld');

// decode the CBOR-LD bytes into a Javascript object
// Note: user must provide their own JSON-LD `documentLoader`
const jsonldDocument = await cborld.decode({cborldBytes, documentLoader});
```

## API 密码

**页:1**: 请检查 `encode.js` 财务报告和审定财务报表 `decode.js` 用于最新的 API 选项.

### 职能

[编码( 选项)](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-encode) ⇒ `Uint8Array`

将给定的 JSON-LD 文档编码为 CBOR-LD 字节数组.

[解码( 选项)](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-decode) ⇒ `object`

将 CBOR-LD 字节数组解码为 JSON-LD 文档.

### 类型防御

[诊断功能](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-diagnosticFunction) 数字 : `function`

诊断功能,使用 诊断信息。 通常设置为 `console.log` 何时 调试中.

[文档 Loader 函数](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-documentLoaderFunction) ⇒ `string`

获取给定的资源并返回 URL 作为弦.

### 编码( 选项) qq `Promise<Uint8Array>`

将给定的 JSON-LD 文档编码为 CBOR-LD 字节数组.

**仁爱**:全球职能 **回返**数字 : `Uint8Array` - 编码的CBOR-LD字节.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 选项 | `object` | 
这个 选项,用于编码到 CBOR-LD 时.

 |
| 选项.jsonldDocument | `object` | 

JSON -LD(日语) 要转换为 CBOR- LD 字节的文档 .

 |
| 选项。文档读取器 | `[documentLoaderFunction](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-documentLoaderFunction)` | 

在解决 JSON- LD 上下文 URL 时使用的文档加载器 .

 |
| \[选项.appContextMap\] | `Map` | 

JSON- LD 上下文 URL 及其编码的 CBOR- LD 值的映射 (数值必须大于32767 (0x7FFF)).

 |
| \[选项.apptermMap\] (英语) | `Map` | 

JSON-LD术语及其相关 CBOR-LD名词代码.

 |
| \[选项.诊断\] | `[diagnosticFunction](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-diagnosticFunction)` | 

如果提供这种功能,则称为诊断 资料.

 |

### 解码( 选项) qq `Promise<object>`

将 CBOR-LD 字节数组解码为 JSON-LD 文档.

**仁爱**:全球职能 **回返**数字 : `object` - 解码的JSON -LD文档.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 选项 | `object` | 
解码 CBOR- LD 时使用的选项 .

 |
| 选项.cborldBytes | `Uint8Array` | 

编码的 CBOR- LD 字节为 解码.

 |
| 选项。文档读取器 | `function` | 

文档加载器 解决 JSON- LD 上下文 URL .

 |
| \[选项.appContextMap\] | `Map` | 

JSON- LD 上下文 URL 和 它们相关的 CBOR-LD 值。 数值必须大于 32767 (0x7FFF) (英语).

 |
| \[选项.apptermMap\] (英语) | `Map` | 

JSON-LD术语和 他们相关的 CBOR-LD 术语代码.

 |
| \[选项.诊断\] | `[diagnosticFunction](https://npmcn.com/package/%40digitalbazaar/cborld/#readme-diagnosticFunction)` | 

一个函数,如果 提供诊断信息.

 |

### 诊断功能 : `function`

诊断功能,与诊断信息相呼应. 一般来说 设置为 `console.log` 当调试时.

**仁爱**: 全局类型def

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 消息 | `string` | 
诊断信息.

 |

### 文档 Loader 函数 {} `string`

获取一个给定的 URL 资源并将它作为字符串返回 .

**仁爱**: 全局类型def **回返**数字 : `string` - 与 URL 作为字符串相关的资源 .

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| url 密码 | `string` | 
要检索的 URL .

 |

实例:

```
TBD
```

## 贡献

请遵循现有的代码样式 .

公关接受.

如果编辑 README, 请遵守 [标准读取](https://github.com/RichardLitt/standard-readme) 规格.

## 商业支助

该图书馆的商务支助可应下列请求提供: 数字集市: [支持@ digitalbazaar.com](mailto:support@digitalbazaar.com)

## 许可证

[BSD-3- 标签](https://npmcn.com/package/%40digitalbazaar/cborld/LICENSE.md) 数字集市

## 常见问题

### @digitalbazaar/cborld 是什么？

用于Javascript的 CBOR-LD 编码器/解码器\.

### 如何安装 @digitalbazaar/cborld？

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

### @digitalbazaar/cborld 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/digitalbazaar\_\_cborld 是否存在。

### @digitalbazaar/cborld 支持 ESM 还是 CommonJS？

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

### @digitalbazaar/cborld 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @digitalbazaar/cborld 可以商用吗？

@digitalbazaar/cborld 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @digitalbazaar/cborld 的下载量有多少？

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

### @digitalbazaar/cborld 还在维护吗？

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