Skip to main content

Function: decompress()

decompress(compressed): null | string

A utility function that allows decompressing the config object (compressed by compress). It decodes it to a string that should be JSON.parsed.

This is the decompressFromEncodedURIComponent function re-exported from lz-string for convenience.

Parameters​

• compressed: string

A string obtained from a call to compressToEncodedURIComponent().

Returns​

null | string

The decompressed string or null if it fails

Param​

The string to be decompressed

Example​

const decompressed = decompress(str);
if (decompressed) {
  try {
    const config = JSON.parse(decompressed);
  } catch {
    // invalid JSON
  }
}

Defined in​

src/sdk/index.ts:545

Sponsors