{"_id":"lzjs","_rev":"28-b9b9d2f79dafcd8d2a490bc2456f6c32","name":"lzjs","description":"A JavaScript library for compressing and decompressing strings using an original algorithm based on the LZ algorithm","dist-tags":{"latest":"1.3.1"},"versions":{"1.2.4":{"name":"lzjs","version":"1.2.4","description":"Compression by LZ algorithm in JavaScript.","main":"lzjs.js","directories":{"test":"tests"},"dependencies":{},"devDependencies":{"mocha":"*"},"scripts":{"test":"mocha tests/test"},"bin":{"lzjs":"bin/lzjs"},"repository":{"type":"git","url":"git@github.com:polygonplanet/lzjs.git"},"keywords":["compression","compress","lz","lz77","lzss","base64","string"],"author":{"name":"polygon planet"},"license":"MIT","bugs":{"url":"https://github.com/polygonplanet/lzjs/issues"},"homepage":"https://github.com/polygonplanet/lzjs","gitHead":"b75572b337d667d17e44de6cf3f2e5f572a2d7d7","_id":"lzjs@1.2.4","_shasum":"6bae53e3215fa22856b8a5c5d90b63a7286ed1e6","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"},"maintainers":[{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"}],"dist":{"shasum":"6bae53e3215fa22856b8a5c5d90b63a7286ed1e6","tarball":"https://registry.npmjs.org/lzjs/-/lzjs-1.2.4.tgz","integrity":"sha512-Z6zNAZibo/6dRnogQzrJzCQtvrTk47yH2cAw6zaMMhBI2FaJZcbZnUktkqCB+nJbNK7fxnZdN/BQ0X2eWaldTw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICEF2Q1/HgM/bWDO7CNTApKVS4jZZsB2WurxnXUEqfRxAiBqCoFx4HggQtfoBCpgo+cI3379n0zG6msmr6538CCOZA=="}]}},"1.2.5":{"name":"lzjs","version":"1.2.5","description":"Compression by LZ algorithm in JavaScript.","main":"lzjs.js","directories":{"test":"tests"},"dependencies":{},"devDependencies":{"mocha":"*"},"scripts":{"test":"mocha tests/test"},"bin":{"lzjs":"bin/lzjs"},"repository":{"type":"git","url":"git@github.com:polygonplanet/lzjs.git"},"keywords":["compression","compress","lz","lz77","lzss","base64","string"],"author":{"name":"polygon planet"},"license":"MIT","bugs":{"url":"https://github.com/polygonplanet/lzjs/issues"},"homepage":"https://github.com/polygonplanet/lzjs","_id":"lzjs@1.2.5","_shasum":"b2e98e45df2d9a62518574f32a5c01a66c990fce","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"},"maintainers":[{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"}],"dist":{"shasum":"b2e98e45df2d9a62518574f32a5c01a66c990fce","tarball":"https://registry.npmjs.org/lzjs/-/lzjs-1.2.5.tgz","integrity":"sha512-wCMaBHNmoe1ImJxFmtUS/rwfkHut7p6N1joph7tslsmDZjZjhooEqRA8miwtHElCbv3S8hLOT9KlVhu+YNVaJg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDM+2m+PJ1YKd60RSadw9e9Desy9nWH/7Xs5fhkf6Cx3QIhAKJ2y1rn+Zl5RUyfiTS8RdiwoWikCU6qf2Ehd3YCO8fL"}]}},"1.3.0":{"name":"lzjs","version":"1.3.0","description":"Compression by LZ algorithm in JavaScript.","main":"lzjs.js","directories":{"test":"tests"},"dependencies":{},"devDependencies":{"mocha":"*"},"scripts":{"test":"mocha tests/test"},"bin":{"lzjs":"bin/lzjs"},"repository":{"type":"git","url":"git@github.com:polygonplanet/lzjs.git"},"keywords":["compression","lz77","lzss","base64","string"],"author":{"name":"polygon planet"},"license":"MIT","bugs":{"url":"https://github.com/polygonplanet/lzjs/issues"},"homepage":"https://github.com/polygonplanet/lzjs","_id":"lzjs@1.3.0","_shasum":"235a87a8dd0b7d08fc97044d922c337246624458","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"},"maintainers":[{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"}],"dist":{"shasum":"235a87a8dd0b7d08fc97044d922c337246624458","tarball":"https://registry.npmjs.org/lzjs/-/lzjs-1.3.0.tgz","integrity":"sha512-oI0Q2sVXSTK63lG49h0pLqY5KyL7Zjv4mkYvgg6tKW1sm08a1gJl3zgpfUVlLZGeukJGq35eLxZ1ggCWlpvN1w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD47KlUyV8M35vwdQjF5anZzQichApmFSxFe5MJH8O/AAIhANla+nu1X5PpQhqGl5KpwDOmw2tLHsE3Qs4Y99lVXwdo"}]}},"1.3.1":{"name":"lzjs","version":"1.3.1","description":"A JavaScript library for compressing and decompressing strings using an original algorithm based on the LZ algorithm","main":"lzjs.js","directories":{"test":"tests"},"devDependencies":{"eslint":"^8.42.0","mocha":"^10.2.0","uglify-js":"^3.17.4"},"scripts":{"minify":"uglifyjs lzjs.js -o lzjs.min.js --comments -c -m -b ascii_only=true,beautify=false","test":"eslint . && mocha tests/test.js"},"engines":{"node":">=14.15.0"},"bin":{"lzjs":"bin/lzjs"},"repository":{"type":"git","url":"git+ssh://git@github.com/polygonplanet/lzjs.git"},"keywords":["compression","lz77","lzss","base64","string"],"author":{"name":"polygonplanet"},"license":"MIT","bugs":{"url":"https://github.com/polygonplanet/lzjs/issues"},"homepage":"https://github.com/polygonplanet/lzjs","_id":"lzjs@1.3.1","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-GaG2+jehuwso7b4eIIKOY6pMDKmLbUcm+YuuX7caTheDnEd4NE8De+sou7Ue0fA24847glcvFFT0j7KmZGb00g==","shasum":"5bd12e8ede8b12bdfa98330bf6be8e00f42a8bd0","tarball":"https://registry.npmjs.org/lzjs/-/lzjs-1.3.1.tgz","fileCount":6,"unpackedSize":48588,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/QdjFb26sywtz3GmjfhMmiZWMH0AOo23DHbM1NS10IwIhAKJYpIQNR5PP5ZJ+0pT7AelKwiALevSLY8Y5tM1v5YY8"}]},"_npmUser":{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"},"maintainers":[{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lzjs_1.3.1_1686645215638_0.13986722821869435"},"_hasShrinkwrap":false}},"readme":"lzjs\n========\n\n[![GitHub Actions Build Status](https://github.com/polygonplanet/lzjs/actions/workflows/ci.yml/badge.svg)](https://github.com/polygonplanet/lzjs/actions)\n\nlzjs is a JavaScript library that compresses and decompresses strings using an original algorithm based on the LZ algorithm.\n\nThis can be particularly useful when storing large amounts of data in storage with size limitations, such as localStorage or cookies.\n\n## Installation\n\n### npm\n\n```bash\n$ npm install --save lzjs\n```\n\n#### using `import`\n\n```javascript\nimport lzjs from 'lzjs';\n```\n\n#### using `require`\n\n```javascript\nconst lzjs = require('lzjs');\n```\n\n### browser (standalone)\n\nYou can install the library via npm or download it from the [release list](https://github.com/polygonplanet/lzjs/tags). Use the `lzjs.js` or `lzjs.min.js` files included in the package.  \n\\*Please note that if you use `git clone`, even the *master* branch may be under development.\n\n```html\n<script src=\"lzjs.js\"></script>\n```\nor the minified `lzjs.min.js`:\n\n```html\n<script src=\"lzjs.min.js\"></script>\n```\n\nWhen the script is loaded, the `lzjs` object is defined in the global scope (i.e., `window.lzjs`).\n\n## Demo\n\n* [lzjs compression demo](http://polygonplanet.github.io/lzjs/demo/)\n\n## API\n\n* [compress](#lzjscompressdata-options)\n* [decompress](#lzjsdecompressdata-options)\n* [compressToBase64](#lzjscompresstobase64data)\n* [decompressFromBase64](#lzjsdecompressfrombase64data)\n\n----\n\n### lzjs.compress(data, [options])\n\nCompresses data into a binary string.\n\n#### Arguments\n\n* **data** *(string|Buffer)* : Input data\n* **[options]** *(object)* : Compression options\n  * **onData** *(function (data) {})* : Called when a data is chunked\n  * **onEnd** *(function () {})* : Called when process ends\n\n#### Returns\n\n*(string)* : Compressed data\n\n#### Example\n\nExample of compressing and decompressing a string.\n\n```javascript\nconst data = 'hello hello hello';\nconst compressed = lzjs.compress(data);\nconsole.log(compressed); // 'Whello \\x80\\x82\\x84\\x86\\x83'\n\nconst decompressed = lzjs.decompress(compressed);\nconsole.log(decompressed === data); // true\n```\n\nCompress data using `onData` and `onEnd` events.\n\n```javascript\nconst string = 'hello hello hello';\nconst compressed = [];\n\nlzjs.compress(string, {\n  onData: (data) => {\n    compressed.push(data);\n  },\n  onEnd: () => {\n    console.log(compressed.join('')); // 'Whello \\x80\\x82\\x84\\x86\\x83'\n  }\n});\n```\n\n----\n\n### lzjs.decompress(data, [options])\n\nDecompresses a string that has been compressed with [`lzjs.compress()`](#lzjscompressdata-options)\n\n#### Arguments\n\n* **data** *(string)* : Input data\n* **[options]** *(object)* : Decompression options\n  * **onData** *(function (data) {})* : Called when a data is chunked\n  * **onEnd** *(function () {})* : Called when process ends\n\n#### Returns\n\n*(string)* : Decompressed data\n\n#### Example\n\nExample of decompressing a string that has been compressed with [`lzjs.compress()`](#lzjscompressdata-options).\n\n```javascript\nconst decompressed = lzjs.decompress('Wabc\\x80\\x82\\x81\\x83\\x83');\nconsole.log(decompressed); // 'abcabcabcabcabc'\n```\n\nDecompress data using `onData` and `onEnd` events.\n\n```javascript\nconst compressed = 'Whello \\x80\\x82\\x84\\x86\\x83';\nconst decompressed = [];\n\nlzjs.decompress(compressed, {\n  onData: (data) => {\n    decompressed.push(data);\n  },\n  onEnd: () => {\n    console.log(decompressed.join('')); // 'hello hello hello'\n  }\n});\n```\n\n----\n\n### lzjs.compressToBase64(data)\n\nCompresses and encodes data into a Base64 string.\n\n#### Arguments\n\n* **data** *(string|Buffer)* : Input data\n\n#### Returns\n\n*(string)* : Compressed and Base64 encoded string\n\n#### Example\n\n```javascript\nconst data = 'hello hello hello';\nconst compressed = lzjs.compressToBase64(data);\nconsole.log(compressed); // 'V2hlbGxvIMKAwoLChMKGwoM='\n```\n\n----\n\n### lzjs.decompressFromBase64(data)\n\nDecompresses a string that has been compressed with [`lzjs.compressToBase64()`](#lzjscompresstobase64data).\n\n#### Arguments\n\n* **data** *(string)* : Input data\n\n#### Returns\n\n*(string)* : Decompressed data\n\n#### Example\n\n```javascript\nconst decompressed = lzjs.decompressFromBase64('V2FiY8KAwoLCgcKDwoM=');\nconsole.log(decompressed); // 'abcabcabcabcabc'\n```\n\n## Command line usage\n\nAfter `npm install -g lzjs`\n\n#### Add file to archive\n\n```bash\nlzjs -a something.txt\n```\n\n#### Extract file\n\n```bash\nlzjs -x something.txt.lzjs\n```\n\n### All command line options\n\n```\n  -h, --help                 show Help\n  -v, --version              show Version\n  -a, --add <file_name>      Add file to archive\n  -x, --extract <file_name>  eXtract file\n```\n\nNote that command line compression is only valid for the UTF-8 encoded file.\n\n## Contributing\n\nWe welcome contributions from everyone.\nFor bug reports and feature requests, please [create an issue on GitHub](https://github.com/polygonplanet/lzjs/issues).\n\n### Pull Requests\n\nBefore submitting a pull request, please run `$ npm run test` to ensure there are no errors.\nWe only accept pull requests that pass all tests.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\nSee the [LICENSE](LICENSE) file for details.\n","maintainers":[{"name":"polygonplanet","email":"polygon.planet.aqua@gmail.com"}],"time":{"modified":"2023-06-13T08:33:35.925Z","created":"2014-11-09T17:53:42.050Z","1.0.1":"2014-11-09T17:53:42.050Z","1.0.2":"2014-11-10T15:10:00.119Z","1.1.0":"2014-11-22T00:36:33.704Z","1.2.0":"2014-11-26T18:10:00.930Z","1.2.1":"2014-11-26T18:17:41.665Z","1.2.2":"2014-11-26T18:25:39.219Z","1.2.3":"2014-11-26T18:30:35.102Z","1.2.4":"2014-12-16T11:38:53.517Z","1.2.5":"2015-10-04T06:56:06.182Z","1.3.0":"2015-10-06T12:22:07.225Z","1.3.1":"2023-06-13T08:33:35.824Z"},"homepage":"https://github.com/polygonplanet/lzjs","keywords":["compression","lz77","lzss","base64","string"],"repository":{"type":"git","url":"git+ssh://git@github.com/polygonplanet/lzjs.git"},"author":{"name":"polygonplanet"},"bugs":{"url":"https://github.com/polygonplanet/lzjs/issues"},"license":"MIT","readmeFilename":"README.md"}