# lz-string

> LZ-based compression algorithm

Latest version **1.5.0** (published 2023-03-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install lz-string
pnpm add lz-string
yarn add lz-string
bun add lz-string
```

Provides the command `lz-string`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2023-03-04 |
| First published | 2013-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 171.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4435 |
| Author | pieroxy |
| Maintainers | pieroxy |
| Keywords | lz, compression, string |

## Links

- npm: https://www.npmjs.com/package/lz-string
- Repository: https://github.com/pieroxy/lz-string
- Homepage: http://pieroxy.net/blog/pages/lz-string/index.html
- Issues: https://github.com/pieroxy/lz-string/issues
- npm.io page: https://npm.io/package/lz-string

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 1.5.0 (latest) — 2023-03-04
- 1.4.4 — 2015-05-25
- 1.4.3 — 2015-04-26
- 1.4.2 — 2015-04-26
- 1.4.1 — 2015-03-23
- 1.4.0 — 2015-03-23
- 1.3.6 — 2014-12-18
- 1.3.5 — 2014-12-15
- 1.3.3 — 2013-10-27

## README

lz-string
=========
LZ-based compression algorithm for JavaScript

## Warning (migrating from version 1.3.4 - nov 2014)
Files have changed locations and name since a recent release. The new release file is in `libs/lz-string.min.js` (or in `libs/lz-string.js` if you don't care for the minified version)

Sorry about the mess in other repos. This will not happen again.

## Note on server side

If you are using one of the ports of lz-string to decode on the server what was encoded in the browser, you might want to use version 1.3.7 as the version 1.3.8 introduced a slight change in the encoding. While the JS versions are completely cross-compatible, the PHP, Go, ... versions might not be as forgiving.

## Install via [npm](https://npmjs.org/)

```shell
$ npm install -g lz-string
$ lz-string input.js > output.txt
```

## Home page
Home page for this program with examples, documentation and a live demo: http://pieroxy.net/blog/pages/lz-string/index.html

## Other languages
This lib has numerous ports to other languages, for server side processing, mostly. Here they are:


* **Java:** [by Diogo Duailibe](https://github.com/diogoduailibe/lzstring4j)
* **Java:** [by rufushuang, with base64 support and better performances](https://github.com/rufushuang/lz-string4java)
* **C#:** [by Jawa-the-Hutt](https://github.com/jawa-the-hutt/lz-string-csharp)
* **C#:** [by kreudom, another implementation in C#, more up to date](https://github.com/kreudom/lz-string-csharp)
* **PHP:** [by nullpunkt](https://github.com/nullpunkt/lz-string-php)
* **Python3:** [by eduardtomasek](https://github.com/eduardtomasek/lz-string-python)
* **Another Python:** [by marcel-dancak](https://github.com/marcel-dancak/lz-string-python)
* **Go** [I helped a friend to write a Go implementation of the decompression algorithm](https://github.com/pieroxy/lz-string-go)
* **Go** [Austin wrote the decompression part as well](https://github.com/Lazarus/lz-string-go)
* **Elixir** [by Michael Shapiro](https://github.com/koudelka/elixir-lz-string)
* **C++/QT** [by AmiArt](https://github.com/AmiArt/qt-lzstring)
* **C++** [by Andrey Krasnov, another implementation in C++11](https://github.com/andykras/lz-string-cpp)
* **VB.NET** [by gsemac](https://github.com/gsemac/lz-string-vb)
* **Salesforce Apex** (Java like language): [bilal did the port](https://github.com/bilalfastian/LZ4String)
* **Kotlin:** [from Zen Liu](https://github.com/ZenLiuCN/lz-string4k)
* **Dart:** [from skipness](https://github.com/skipness/lzstring-dart)
* **Haxe:** [from markknol](https://github.com/markknol/hx-lzstring)
* **Rust:** [from adumbidiot](https://github.com/adumbidiot/lz-str-rs)

---
_Source: https://npm.io/package/lz-string · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._