Socket
Socket
Sign inDemoInstall

lz-string

Package Overview
Dependencies
0
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

lz-string

LZ-based compression algorithm

    1.5.0latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
11,104,454
increased by4.93%

Weekly downloads

Package description

What is lz-string?

The lz-string npm package provides compression and decompression functionalities for strings. It is designed to be lightweight and fast, and it can compress data to a smaller size to save storage space or reduce the amount of data transmitted over the network.

What are lz-string's main functionalities?

Compression

This feature allows you to compress a string into a smaller one, which can be useful for saving space or reducing the size of data sent over the network.

const LZString = require('lz-string');
const compressed = LZString.compress('This is my string to compress.');

Decompression

This feature allows you to decompress a string that was previously compressed with lz-string, restoring it to its original form.

const LZString = require('lz-string');
const compressed = LZString.compress('This is my string to compress.');
const decompressed = LZString.decompress(compressed);

Compression to UTF-16

This feature compresses a string and encodes it in UTF-16 format, which can be useful for environments that do not support UTF-8.

const LZString = require('lz-string');
const compressed = LZString.compressToUTF16('This is my string to compress.');

Decompression from UTF-16

This feature decompresses a string that was compressed to UTF-16 format back to its original string.

const LZString = require('lz-string');
const compressed = LZString.compressToUTF16('This is my string to compress.');
const decompressed = LZString.decompressFromUTF16(compressed);

Compression to Base64

This feature compresses a string and encodes it in Base64, which is useful for safe transport over protocols that might not handle binary data well.

const LZString = require('lz-string');
const compressed = LZString.compressToBase64('This is my string to compress.');

Decompression from Base64

This feature decompresses a string that was compressed and encoded in Base64 back to its original string.

const LZString = require('lz-string');
const compressed = LZString.compressToBase64('This is my string to compress.');
const decompressed = LZString.decompressFromBase64(compressed);

Other packages similar to lz-string

Changelog

Source

[1.5.0] - 2023-06-20

  • Minified version

Readme

Source

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

$ 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:

Keywords

FAQs

Last updated on 04 Mar 2023

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc