@larrym/lz-string

LZ-based compression algorithm for JavaScript with full ESM (ECMAScript Modules) support.

This package is a modern ESM-compatible fork of the original lz-string library by pieroxy, providing the same powerful compression capabilities with improved module support.

Features

- Full ESM (ECMAScript Modules) support
- CommonJS compatibility for legacy projects
- TypeScript type definitions included
- Zero dependencies
- Works in Node.js and browsers
- Multiple compression formats (Base64, UTF-16, URI-safe, Uint8Array)

Requirements

- Node.js >= 18.0.0

Installation

``bash
npm install @larrym/lz-string
`

Usage

$3

`javascript
import { compress, decompress, compressToBase64, decompressFromBase64 } from '@larrym/lz-string';

// Basic compression
const compressed = compress('Hello, World!');
const decompressed = decompress(compressed);

// Base64 compression
const compressedB64 = compressToBase64('Hello, World!');
const decompressedB64 = decompressFromBase64(compressedB64);
`

$3

`javascript
const { compress, decompress } = require('@larrym/lz-string');

const compressed = compress('Hello, World!');
const decompressed = decompress(compressed);
`

$3

`javascript
import LZString from '@larrym/lz-string';

const compressed = LZString.compress('Hello, World!');
const decompressed = LZString.decompress(compressed);
`

API

$3

Compresses a string and returns the compressed string.

$3

Decompresses a string compressed with compress().

$3

Compresses a string to a Base64 encoded string.

$3

Decompresses a Base64 encoded string.

$3

Compresses a string to UTF-16 format.

$3

Decompresses a UTF-16 compressed string.

$3

Compresses a string to a URI-safe format.

$3

Decompresses a URI-safe compressed string.

$3

Compresses a string to a Uint8Array.

$3

Decompresses a Uint8Array.

Browser Usage

You can use this package directly in modern browsers with ESM support:

`html

`

Differences from Original lz-string

- Native ESM support with proper package.json` exports
- Maintained TypeScript definitions
- Modern JavaScript syntax (const/let instead of var)
- Simplified module structure

License

MIT License - see LICENSE file for details

Original work Copyright (c) 2013 pieroxy
Modified work Copyright (c) 2025 Larry Motalavigne

Credits

This package is based on the original lz-string library by pieroxy.