[fork-link]: https://github.com/LZMA-JS/LZMA-JS
[fork-author]: https://github.com/nmrugg
[7zip-sdk]: https://www.7-zip.org/sdk.html
[go-sdk]: https://code.google.com/p/lzma

Why

There are many LZMA implementations in JavaScript, but most are outdated,
unmaintained, lack type support, or rely on specific runtime APIs (e.g., Node.js
Buffer).

This version has been cleaned up, with TypeScript types added to make it easier
to read and maintain.

Features

- Encode and decode LZMA streams
- Supports both string and Uint8Array data
- Supports both browser and Node.js environments
- Pure JavaScript implementation with TypeScript types
- No dependencies on runtime-specific APIs

Installation

> [!NOTE]
> This package is native [ESM][mozzila-esm] and no longer provides a CommonJS
> export. If your project uses CommonJS, you will have to convert to ESM or use
> the dynamic [import()][mozzila-import] function.

[mozzila-esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[mozzila-import]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import

$3

``sh
npm install lzma1
`

$3

`html

`

Quick start

The library provides four main functions for compression and decompression:

`ts
// For binary data
compress(data: Uint8Array | ArrayBuffer, mode?: 1-9): Uint8Array
decompress(data: Uint8Array | ArrayBuffer): Uint8Array

// For string data
compressString(data: string, mode?: 1-9): Uint8Array
decompressString(data: Uint8Array | ArrayBuffer): string
`

You can also import the LZMA class directly for more advanced usage:

`ts
import { LZMA } from "lzma1";

const lzma = new LZMA();
const compressed = lzma.compressString("Hello World!", 5);
const decompressed = lzma.decompressString(compressed);
`

$3

`js
import {
compressString,
decompressString,
} from "lzma1";

const data = "Hello World!";
const compressed = compressString(data, 1); // Using compression level 1 (fastest)
const decompressed = decompressString(compressed);

// data === decompressed
`

$3

`js
import {
compress,
decompress,
} from "lzma1";

// Compress binary data
const binaryData = new Uint8Array([0x01, 0x02, 0x03, 0x04]);
const compressed = compress(binaryData, 5); // Default compression level

// Decompress back to binary
const decompressed = decompress(compressed);
// decompressed will be a Uint8Array
`

$3

A simple browser example:

`html



Hello World!

Compress & Decompress





``

How it works

LZMA (Lempel-Ziv-Markov chain Algorithm) is a compression algorithm that uses a
dictionary compression scheme. It's known for its high compression ratio and is
commonly used in the 7z archive format.

$3

The LZMA compressed data begins with a header that contains information needed
for decompression:

!lzma

More [information][header_link] about the LZMA header structure.

[header_link]: https://docs.fileformat.com/compression/lzma/#lzma-header

Related

- lzma-purejs
- lzmajs
- lzma-purejs fork