1.0.3 • Published 6 years ago
json-crunch v1.0.3
JSON Crunch
Provides methods for removing whitespace from JSON files to save space.
Installation
You can install JSON Crunch using npm:
npm install json-crunch
or
npm install --save-dev json-crunch
Usage
JSON Crunch has two methods: crunch
and crunchToFile
jsonCrunch.crunch(filename, encoding="utf8")
- Crunches contents of specified file and returns it in string form. (Returns a promise)jsonCrunch.crunchToFile(sourceFile, destFile, encoding="utf8", stats=false)
- Crunches contents of file and writes result to another file. (Returns a promise) - Ifstats
istrue
, an object is returned of the form{ input: Number, output: Number, percent: Number, saved: Number }
; -input
- size of input file -output
- size of crunched file -percent
- percentage of original used for crunched -saved
- percent smaller crunched is from original
Example
const jc = require('json-crunch');
jc.crunchToFile("./source.json", "./source.min.json", "utf8").then(() = > {
console.log("Successfully crunched file");
}).catch((e) => {
console.log("Error occured: " e);
});
License
Released under MIT license