https://github.com/williamvenner/node-bzip2

NodeJS bindings for BZip2 (libbz2)
https://github.com/williamvenner/node-bzip2

bun bz2 bzip bzip2 bzip2-js deno javascript js libbz libbz2 libbzip libbzip2 node nodejs ts typescript

Last synced: 3 months ago
JSON representation

NodeJS bindings for BZip2 (libbz2)

• Host: GitHub
• URL: https://github.com/williamvenner/node-bzip2
• Owner: WilliamVenner
• License: mit
• Created: 2024-06-04T00:19:21.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-06-06T21:48:02.000Z (8 months ago)
• Last Synced: 2024-10-14T01:33:24.427Z (4 months ago)
• Topics: bun, bz2, bzip, bzip2, bzip2-js, deno, javascript, js, libbz, libbz2, libbzip, libbzip2, node, nodejs, ts, typescript
• Language: C++
• Homepage: https://npmjs.com/package/node-bzip2
• Size: 80.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![NPM](https://img.shields.io/npm/v/node-bzip2.svg)](https://www.npmjs.com/package/node-bzip2)

# node-bzip2

NodeJS bindings for BZip2 (libbz2).

This package will compile the BZip2 library from source and link against it, exposing functions for compressing and decompressing data using the BZip2 algorithm in NodeJS.

**This package does not work on the web and is designed for use in NodeJS only.**

## Installation

```bash

npm install node-bzip2 --save

```

## Usage

The package exposes two functions: `compress` and `decompress` (and their respective async versions `compressAsync` and `decompressAsync`).

Both functions can take a `string`, [`Buffer`](https://nodejs.org/api/buffer.html), or [typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays) as input and return a [`Buffer`](https://nodejs.org/api/buffer.html) containing the compressed or decompressed data.

Additional options such as compression level and buffering behavior can be passed as an optional second argument, explained in the respective functions' JSDocs.

```javascript

const bzip2 = require('node-bzip2');

// Compress some data

const compressedBytes = bzip2.compress('Hello, world!', { level: 9, buffering: 'auto' });

// Decompress the data

const decompressedBytes = bzip2.decompress(compressedBytes, { small: false });

// Decode the decompressed data as a UTF-8 string

const decompressed = (new TextDecoder('utf8')).decode(decompressedBytes);

console.log(decompressed); // Hello, world!

```

You can also use the async functions to compress and decompress data asynchronously:

```javascript

const bzip2 = require('node-bzip2');

// Compress some data

const compressedBytes = await bzip2.compressAsync('Hello, world!', { level: 9, buffering: 'auto' });

// Decompress the data

const decompressedBytes = await bzip2.decompressAsync(compressedBytes, { small: false });

// Decode the decompressed data as a UTF-8 string

const decompressed = (new TextDecoder('utf8')).decode(decompressedBytes);

console.log(decompressed); // Hello, world!

```