https://github.com/willscott/js-rle

RLE+ encoding/decoding
https://github.com/willscott/js-rle

rle

Last synced: about 1 year ago
JSON representation

RLE+ encoding/decoding

• Host: GitHub
• URL: https://github.com/willscott/js-rle
• Owner: willscott
• License: mit
• Created: 2020-04-17T21:22:28.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T21:48:26.000Z (almost 3 years ago)
• Last Synced: 2025-02-06T10:31:14.674Z (over 1 year ago)
• Topics: rle
• Language: JavaScript
• Homepage:
• Size: 120 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# JS-RLE

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

![Node.js CI](https://github.com/willscott/js-rle/workflows/Node.js%20CI/badge.svg)

A Javascript implementation of the RLE+ Spec.

See: https://github.com/filecoin-project/specs/blob/master/data-structures.md#rle-bitset-encoding

## Install

```

npm install js-rle

```

## Usage

```javascript

const RLE = require('js-rle');

let encoded = RLE.Encode(buffer);

let decoded = RLE.Decode(encoded);

```

The interface expects the JS `ArrayBuffer` type.

## Maintainers

[@willscott](https://github.com/willscott).

## Contributing

Feel free to dive in! [Open an issue](https://github.com/willscott/js-rle/issues/new) or submit PRs.

## License

[MIT](LICENSE) © Will Scott