bz2/README.md

24 lines
475 B
Markdown
Raw Normal View History

2019-06-25 00:00:17 +00:00
# bz2
bzip2 library for JavaScript
```js
import { decompress } from 'bz2';
const output = decompress(input);
```
Available from the npm registry as `bz2`
and from the GitHub registry as `@sheetjs/bz2`.
2020-12-31 14:16:45 +00:00
Try out the [demo](https://oss.sheetjs.com/bz2).
2019-06-25 00:00:17 +00:00
## API
2019-07-01 16:18:28 +00:00
### `decompress(data, test)`
2019-06-25 00:00:17 +00:00
* `data`: `Uint8Array` - The data to be decompressed.
2019-07-01 16:18:28 +00:00
* `test`: `boolean` - Verify integrity of compressed data. Default: `false`.
2019-06-25 00:00:17 +00:00
* **Returns**: `Uint8Array`
Decompresses `data`.