Compress your JSON to send and get a lot of data to/from server
npm install jsoncomp
|1||downloads in the last week|
|7||downloads in the last month|
|Version||1.6.1 last updated 4 months ago|
Update to version 1.6.1
JSONC exist only with the idea of change the mind of browser companies to make it an standard directly in JSON object to send data to server.
JSONC has two differents approaches to reduce the size of the amount of data to be transported:
- JSONC.compress - Compress JSON objects using a map to reduce the size of the keys in JSON objects.
- Be careful with this method because it's really impressive if you use it with a JSON with a big amount of data, but it could be awful if you use it to compress JSON objects with small amount of data because it could increase the final size.
- The rate compression could variate from 7.5% to 32.81% depending of the type and values of data.
- JSONC.pack - Compress JSON objects using GZIP compression algorithm, to make the job JSONC uses a modification to
use the gzip library and it encodes the gzipped string with Base64 to avoid url encode.
Gzip - @beatgammit - https://github.com/beatgammit/gzip-js
Base64 - http://www.webtoolkit.info/
- You can use pack to compress any JSON objects even if these objects are not been compressed using JSONC See Usage for more details.
Compress a JSON object:
// Returns a JSON object but compressed. var compressedJSON = JSONC.compress( json );
Decompress a JSON object:
// Returns the original JSON object. var json = JSONC.decompress( compressedJSON );
Compress a normal JSON object as a Gzipped string:
// Returns the LZW representation as string of the JSON object. var lzwString = JSONC.pack( json );
Compress a JSON object as a Gzipped string after compress it using JSONC:
// Returns the LZW representation as string of the JSON object. var lzwString = JSONC.pack( json, true );
Decompress a normal JSON object from a Gzipped string:
// Returns the original JSON object. var json = JSONC.unpack( gzippedString );
Decompress a JSON compressed object using JSONC from a Gzipped string:
// Returns the original JSON object. var json = JSONC.unpack( gzippedString, true );
Examples of compression
Original - 17331 bytes Compressed using JSONC - 16025 bytes Compression rate - 7.5% Original compressed using gzip.js - 5715 bytes Compressed using JSONC using gzip.js - 5761 bytes Compression rate from original to compressed using JSONC and gzip.js - 66.76%
Original - 19031 bytes Compressed using JSONC - 12787 bytes Compression rate - 32.81% Original compressed using gzip.js - 4279 bytes Compressed using JSONC using gzip.js - 4664 bytes Compression rate from original to compressed using JSONC and gzip.js - 75.49%