node-heatshrink v1.1.0

Heatshrink compression for Node.js

Heatshrink's Rust implementation binding library using napi-rs.

Usage

export function encodeSync(input: Buffer, windowSize: number, lookaheadSize: number): Buffer
export function decodeSync(input: Buffer, windowSize: number, lookaheadSize: number): Buffer
export function encode(input: Buffer, windowSize: number, lookaheadSize: number, signal?: AbortSignal | undefined | null): Promise<Buffer>
export function decode(input: Buffer, windowSize: number, lookaheadSize: number, signal?: AbortSignal | undefined | null): Promise<Buffer>

where:

1. encode() and encodeSync() are for compression; decode() and decodeSync() are for decompression.
2. windowSize can be 8-11, lookaheadSize is recommended to be the half of, or slightly less than half of the windowSize.

License

MIT