Package Exports

gzip-string
gzip-string/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gzip-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gzip-string

Module for compressing strings using the browsers built in gzip zipping functionality. Hence this module is made for browsers and have not been tested on server-side environments.

Install

npm install gzip-string

Example

import { compress, decompress } from 'gzip-string'

const compressedData = await compress([YOUR STRING])

const yourString = await decompress(compressedData)

Functions:

compress
decompress
compressToURI
decompressFromURI

compress(string, (encoding = 'gzip'))

Compresses the string using the browsers internal compression method.

decompress(password, (times = 1))

Decompresses the provided using the browsers internal decompression method.

compressToURI(password, (times = 1))

Compresses the string using the browsers internal compression method and makes sure it is safe to put in the URI.

decompressFromURI(password, (times = 1))

Decompresses URI encoded strings using the browsers internal compression.