Skip to content

Latest commit

 

History

History
128 lines (90 loc) · 3.39 KB

README.md

File metadata and controls

128 lines (90 loc) · 3.39 KB
Raw

Streaming BZ2 Decompress

Overview

Decompress a bzip2 stream in the browser - no Node.js required.

Table of Contents

Installation

npm i streaming-bz2-decompress

Usage

The library exposes a single function decompressStream which takes care of the decompression process. It requires the callbacks onDecompressed and onError to it in order to pass decompressed data. It returns the actions dataFinished, addData and cancel in order to receive input from the consumer.

use addData to pass compressed data, once whole blocks of BZ2 compressed data are received, they be decompressed and onDecompressed will be called with the decompressed data. Once finished passing compressed datam use dataFinished to trigger the decompression of any remaining uncompressed data.

API

decompressStream

The only function exposed by this library is decompressStream.

export interface DecompressStreamCallbacks {
  onDecompressed: (id: number, data: Uint8Array, done: boolean) => void;
  onError: (id: number, e: string) => void;
}

export interface DecompressStreamActions {
  dataFinished: () => void;
  addData: (data: Uint8Array) => void;
  cancel: () => void;
}

declare function decompressStream(callbacks: DecompressStreamCallbacks): DecompressStreamActions;

Example

Here is a basic example to demonstrate the usage:

let totalReceived = 0;

const decompressionActions = decompressStream({
  onDecompressed: (id, data, done) => {
    totalReceived += data.byteLength;
    console.log('Received data for task ' + id + ': ' + data.byteLength);

    if (done) {
      console.log('Task ' + id + 'done. Received: ' + totalReceived);
    }
  },
  onError: (id, e) => {
    console.error('Error for task ' + id + ': ' + e);
  }
});


const response = await fetch('http://path/to/file.bz2');

if (!response.ok || !response.body) {
  throw Error(`Failed to fetch with status: ${response.statusText || 'unknown'}`);
}

const reader = response.body.getReader();

while (true) {
  const readRes = await reader.read();
  const { done, value } = readRes;

  if (done) {
    decompressionActions.dataFinished();
    break;
  }

  if (!value) {
    throw Error('No value');
  }

  decompressionActions.addData(value);
}

// Received data for task 0: 2728509
// Received data for task 0: 6307939
// Received data for task 0: 13515059
// Received data for task 0: 5403683
// Received data for task 0: 3598647
// Received data for task 0: 21116892

Caveats

  • You might need to install a polyfill for buffer. You can do so by running npm i buffer.
  • There's no CRC validation for the entire file at the end - only the per-block ones. There's no proper BZ2 formet eof detection. That's why onDataFinished is required.

Contributing

  • Currently, there are no tests for this repository. PRs are welcome to add tests.
  • If you want to help with polyfilling buffer, PRs are welcome.

Credits

This library is based on the following repositories:

License

This project is licensed under the MIT License.