让开源，少一点语言距离。
npm包中文文档

@digitalbazaar/bitstring

中文文档
3.1.0发布于 2023/01/09BSD-3-ClauseES Module近 30 天下载 5.6万

Bitstring module for universal JavaScript

原始使用文档
中文原文
文档目录12 节
  1. Install
  2. Usage
  3. API
  4. set(position, on)
  5. get(position)
  6. encodeBits()
  7. decodeBits({encoded})
  8. compressBits()
  9. uncompressBits({compressed})
  10. Contribute
  11. Commercial Support
  12. License

Bitstring

A Bitstring module for universal JavaScript.

Install

To install get the latest version from NPM:

npm install @digitalbazaar/bitstring

To install locally for development:

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

Usage

import {Bitstring} from '@digitalbazaar/bitstring';

// You can make a new instance by passing in a length
const bitstring = new Bitstring({length: 10});

// OR by passing in a buffer
const buffer = Uint8Array.from([255]);
const bitstring = new Bitstring({buffer});

API

set(position, on)

Sets the value of a bit for the given position to the given boolean.

bitstring.set(1, true);

get(position)

Gets the value of a bit for the given position.

bitstring.get(3);

encodeBits()

Compresses and encodes bits to a base64url encoded string.

await bitstring.encodeBits();

decodeBits({encoded})

Decodes and uncompresses a given base64url encoded string to a Uint8Array.

await Bitstring.decodeBits({encoded});

compressBits()

Compresses bits to a Uint8Array.

await bitstring.compressBits();

uncompressBits({compressed})

Uncompresses compressed bits.

await Bitstring.uncompressBits({compressed});

Contribute

Please follow the existing code style.

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: [email protected]

License

BSD-3-Clause © Digital Bazaar

版本与发布记录

@digitalbazaar/bitstring 共发布 7 个版本，首次发布于 2020/07/10；过去 12 个月发布了 0 个版本。

版本发布日期距今
3.1.0latest2023/01/093 年前
3.0.02023/01/093 年前
2.0.02022/06/024 年前
1.2.12022/01/224 年前
1.2.02020/09/266 年前
1.1.02020/07/106 年前

关于 @digitalbazaar/bitstring 的常见问题

@digitalbazaar/bitstring 是什么？

Bitstring module for universal JavaScript

如何安装 @digitalbazaar/bitstring？

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

@digitalbazaar/bitstring 支持 TypeScript 吗？

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

@digitalbazaar/bitstring 支持 ESM 还是 CommonJS？

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

@digitalbazaar/bitstring 需要什么版本的 Node.js？

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

@digitalbazaar/bitstring 可以商用吗？

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

@digitalbazaar/bitstring 的下载量有多少？

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

@digitalbazaar/bitstring 还在维护吗？

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