Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@napi-rs/lzma

Brooooooklyn331.2kMIT1.4.5TypeScript support: included
Node-API, napi, lzma, compress, decompress, xz, napi-rs

readme

@napi-rs/lzma

https://github.com/Brooooooklyn/lzma/actions Install size

lzma-rs binding to Node.js via napi-rs.

🚀 Help me to become a full-time open-source developer by sponsoring me on Github

Install

yarn add @napi-rs/lzma

Support matrix

| | node14 | node16 | node18 | node20 | | --------------------- | ------ | ------ | ------ | ------ | | Windows x64 | ✓ | ✓ | ✓ | ✓ | | Windows x32 | ✓ | ✓ | ✓ | ✓ | | Windows arm64 | ✓ | ✓ | ✓ | ✓ | | macOS x64 | ✓ | ✓ | ✓ | ✓ | | macOS arm64 (m chips) | ✓ | ✓ | ✓ | ✓ | | Linux x64 gnu | ✓ | ✓ | ✓ | ✓ | | Linux x64 musl | ✓ | ✓ | ✓ | ✓ | | Linux arm gnu | ✓ | ✓ | ✓ | ✓ | | Linux arm64 gnu | ✓ | ✓ | ✓ | ✓ | | Linux arm64 musl | ✓ | ✓ | ✓ | ✓ | | Android arm64 | ✓ | ✓ | ✓ | ✓ | | Android armv7 | ✓ | ✓ | ✓ | ✓ | | FreeBSD x64 | ✓ | ✓ | ✓ | ✓ |

API

xz

import { compress, decompress } from '@napi-rs/lzma/xz'

const compressed = await compress('Hello napi-rs 🚀')

const decompressed = await decompress(compressed)

console.log(decompressed.toString('utf8')) // Hello napi-rs 🚀

lzma

import { compress, decompress } from '@napi-rs/lzma/lzma'

const compressed = await compress('Hello napi-rs 🚀')

const decompressed = await decompress(compressed)

console.log(decompressed.toString('utf8')) // Hello napi-rs 🚀

lzma2

import { compress, decompress } from '@napi-rs/lzma/lzma2'

const compressed = await compress('Hello napi-rs 🚀')

const decompressed = await decompress(compressed)

console.log(decompressed.toString('utf8')) // Hello napi-rs 🚀

changelog

1.4.5 (2025-08-10)

1.4.4 (2025-07-23)

Features

1.4.3 (2025-05-19)

Bug Fixes

1.4.2 (2025-05-04)

1.4.1 (2024-09-21)

Bug Fixes

1.4.0 (2024-09-16)

Bug Fixes

  • deps: update rust crate napi to 3.0.0-alpha (#176) (cd01f0e)
  • deps: update rust crate napi-derive to 3.0.0-alpha (#175) (9fb995b)

1.3.1 (2024-04-30)

Bug Fixes

  • add missing browser field (5f56910)

1.3.0 (2024-04-29)

Features

1.2.1 (2023-12-05)

Bug Fixes

1.2.0 (2023-12-05)

Bug Fixes

  • deps: update rust crate lzma-rs to 0.3 (#71) (04345d0)

Features

1.1.2 (2021-12-23)

Bug Fixes

  • publish missing .d.ts file (a393809)

1.1.1 (2021-12-22)

Bug Fixes

  • missing esbuild dependency (5cfb37b)

1.1.0 (2021-12-22)

Features

1.0.0 (2021-09-17)

Features