# LZ-String

Links: [Home](../../index.md)

Wrapper for the [lz-string](https://pieroxy.net/blog/pages/lz-string/index.html) compression library. Compresses strings to compact representations suitable for localStorage or URL parameters.

## Loading

```js
Application.require("thirdparty/archive/lz-string").then(function (LZString) {
    // LZString is ready
});
```

## Use Cases

### Compress data for localStorage

```js
Application.require("thirdparty/archive/lz-string").then(function (LZString) {
    var bigData = JSON.stringify(largeObject);

    var compressed = LZString.compress(bigData);
    localStorage.setItem('data', compressed);

    // Later: decompress
    var restored = LZString.decompress(localStorage.getItem('data'));
    var obj = JSON.parse(restored);
});
```

### Compress for URL-safe transport

```js
Application.require("thirdparty/archive/lz-string").then(function (LZString) {
    var encoded = LZString.compressToEncodedURIComponent(jsonString);
    window.location.hash = encoded;

    // Restore from URL
    var decoded = LZString.decompressFromEncodedURIComponent(window.location.hash.slice(1));
});
```

### Compress for UTF-16 storage

```js
Application.require("thirdparty/archive/lz-string").then(function (LZString) {
    var compressed = LZString.compressToUTF16(largeString);
    var restored = LZString.decompressFromUTF16(compressed);
});
```

## Notes

- API: `compress/decompress`, `compressToUTF16/decompressFromUTF16`, `compressToBase64/decompressFromBase64`, `compressToEncodedURIComponent/decompressFromEncodedURIComponent`
- Reference: [pieroxy.net/blog/pages/lz-string](https://pieroxy.net/blog/pages/lz-string/index.html)