# quickbit-universal

> Universal wrapper for libquickbit with a JavaScript fallback

Latest version **2.2.0** (published 2023-08-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install quickbit-universal
pnpm add quickbit-universal
yarn add quickbit-universal
bun add quickbit-universal
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2023-08-02 |
| First published | 2022-09-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 24.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Kasper Isager Dalsgarð |
| Maintainers | mafintosh, kasperisager |

## Links

- npm: https://www.npmjs.com/package/quickbit-universal
- Repository: https://github.com/holepunchto/quickbit-universal
- Homepage: https://github.com/holepunchto/quickbit-universal#readme
- Issues: https://github.com/holepunchto/quickbit-universal/issues
- npm.io page: https://npm.io/package/quickbit-universal

## Dependencies (3)

- [b4a](https://npm.io/package/b4a.md) ^1.6.0
- [quickbit-native](https://npm.io/package/quickbit-native.md) ^2.2.0
- [simdle-universal](https://npm.io/package/simdle-universal.md) ^1.1.0

## Recent versions

- 2.2.0 (latest) — 2023-08-02
- 2.1.2 — 2023-06-06
- 2.1.1 — 2023-05-11
- 2.1.0 — 2023-05-10
- 2.0.5 — 2023-03-24
- 2.0.4 — 2023-03-24
- 2.0.3 — 2022-10-10
- 2.0.2 — 2022-10-05
- 2.0.1 — 2022-10-05
- 2.0.0 — 2022-10-04
- 1.3.0 — 2022-09-22
- 1.2.3 — 2022-09-22
- 1.2.2 — 2022-09-21
- 1.2.1 — 2022-09-16
- 1.2.0 — 2022-09-16
- … 7 more at https://npm.io/package/quickbit-universal/versions

## README

# quickbit-universal

Universal wrapper for https://github.com/holepunchto/libquickbit with a JavaScript fallback.

```sh
npm install quickbit-universal
```

## Usage

```js
const { get, set, findFirst } = require('quickbit-native')

const field = Buffer.alloc(256) // 2048 bits

const changed = set(field, 1000)
// true

get(field, 1000)
// true

findFirst(field, true)
// 1000
```

## API

#### `const b = get(field, bit)`

Get the given bit, which will either be `true` (set) or `false` (unset).

#### `const changed = set(field, bit[, value])`

Set the given bit to `value`, which defaults to `true`. Returns `true` if the bit changed, otherwise `false`.

#### `field = fill(field, value[, start[, end]])`

Fill the given bit range with `value`. `start` defaults to `0` and `end` defaults to the bit length of the field. Returns the modified field.

#### `clear(field, chunk)`

Clear the bits from `field` that are set in the `{ field, offset }` chunk.

#### `const i = findFirst(field, value[, position])`

Return the index of the first occurrence of `value`, or `-1` if not found. If `position` is given, return the first index that is greater than or equal to `position`.

#### `const i = findLast(field, value[, position])`

Return the index of the last occurrence of `value`, or `-1` if not found. If `position` is given, return the last index that is less than or equal to `position`.

### Indexing

#### `const index = Index.from(fieldOrChunks)`

Construct an index of the bits in a bit field or an array of sparse `{ field, offset }` chunks.

#### `const changed = index.update(bit)`

Update the given bit in the index.

#### `const position = index.skipFirst(value[, position])`

Skip the first parts of the index that contain nothing but `value`. If the index contains *only* `value`, the last index of the field is returned.

#### `const position = index.skipLast(value[, position])`

Skip the last parts of the index that contain nothing but `value`. If the index contains *only* `value`, the first index of the field is returned.

## License

Apache 2.0

---
_Source: https://npm.io/package/quickbit-universal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._