@digitalcredentials/bitstring

中文文档
3.1.2发布于 2023/12/07BSD-3-ClauseESM + CJS近 30 天下载 9517

Bitstring module for universal JavaScript

原始使用文档
文档目录11 节
  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. License

Universal Bitstring Library (@digitalcredentials/bitstring)

Build status NPM Version

A Bitstring module for Javascript (Node, browsers, React Native).

Install

To install get the latest version from NPM:

npm install @digitalcredentials/bitstring

To install locally for development:

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

Usage

import {Bitstring} from '@digitalcredentials/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.

License

BSD-3-Clause © Digital Bazaar

版本与发布记录

@digitalcredentials/bitstring 共发布 3 个版本,首次发布于 2022/08/15;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.1.2latest2023/12/072 年前
3.1.12023/12/072 年前
2.0.12022/08/154 年前

关于 @digitalcredentials/bitstring 的常见问题

@digitalcredentials/bitstring 是什么?

Bitstring module for universal JavaScript

如何安装 @digitalcredentials/bitstring?

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

@digitalcredentials/bitstring 支持 TypeScript 吗?

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

@digitalcredentials/bitstring 支持 ESM 还是 CommonJS?

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

@digitalcredentials/bitstring 需要什么版本的 Node.js?

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

@digitalcredentials/bitstring 可以商用吗?

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

@digitalcredentials/bitstring 的下载量有多少?

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

@digitalcredentials/bitstring 还在维护吗?

最新版本 3.1.2 发布于 2023/12/07(2 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/08/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。