version 1.0.0
A simple JavaScript lib to compress, decompress and optimize javascript object and json data exchange with the help of GZIP and Base64. This library try to reduce object size by replacing keys with smaller ones. Thus, an object with a lot of different keys that never repeat will be harder to compressed efficiently. It could even increase the size of the result for small object. As for now, only object and json object can be used.
I had to work with lots and lots of big json objects and wanted to find a way to compress them better so that i could more easily store them inside localstorage and also spare some bandwidth. At the time, i found this neat lib : https://github.com/tcorral/JSONC wich did a great work, but then i wanted to use it in Node and it would not work for me. So i decided to try and write my own library to do the job. So thanks to tcorral for getting me in the right direction. And also thanks to the wonderfull library https://github.com/nodeca/pako, which GZON rely on to do some of its work.
Just use one of the three files in the dist folder and you are good to go! gzon.standalone.min.js contains pako library but the other two files do not. You will have to include pako in your project for them to work.
You could also require("GZON") on the source.
You can read throught this huge documentation :)
See the index.html file to test it live with a demo object.
With the demo there, the initial json data string is ~28kb and the compressed result is ~3kb. Those results can vary depending of the input object.
The test file also show some numbers :
'Efficiency small object : 0.7X increase 0.16k --> 0.22k'
'Efficiency big object : 8.1X reduction 24.26k --> 2.99k'
'Efficiency small object : 1.2X reduction 0.16k --> 0.13k'
'Efficiency big object : 3.1X reduction 130.90k --> 41.66k'
Should you want to update the library, just npm install and npm run bundle or npm run bundle-minified to build the library
- More tests with big data