https://github.com/jcubic/lzjb-pack
No Dependency fast and small LZJB Compression for Node and browser
https://github.com/jcubic/lzjb-pack
compression compression-implementations javascript javascript-library
Last synced: 6 months ago
JSON representation
No Dependency fast and small LZJB Compression for Node and browser
- Host: GitHub
- URL: https://github.com/jcubic/lzjb-pack
- Owner: jcubic
- License: bsd-3-clause
- Created: 2021-10-26T14:40:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-27T10:46:12.000Z (over 4 years ago)
- Last Synced: 2025-03-12T18:43:04.858Z (11 months ago)
- Topics: compression, compression-implementations, javascript, javascript-library
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lzjb-pack
[No Dependency fast and small LZJB Compression for Node and browser](https://github.com/jcubic/lzjb-pack)
## Installation
```bash
npm install lzjb-pack
```
## Usage
Packing:
```javascript
import { pack } from 'lzjb-pack';
import * as fs from 'fs';
import { readFile, writeFile } from 'fs/promises';
readFile('package.json').then(buffer => {
writeFile('package.json.lzjb', pack(buffer));
});
```
Unpacking:
```javascript
import { unpack } from 'lzjb-pack';
import { readFile, writeFile } from 'fs/promises';
readFile('package.json.lzjb').then(buffer => {
writeFile('package-unpack.json', unpack(buffer));
});
```
## API
* `pack(Uint8Array | Buffer, { magic: boolean }): Uint8Array`
* `unpack(Uint8Array | Buffer, { magic: boolean }): Uint8Array`
if magic option is set to false magic string is not added to the output byte array.
## License
Copyright (c) 2021 [Jakub Jankiewicz](https://jcubic.pl/me)
Released under BSD-3-Clause License