Write json file npm

Easily read/write JSON files in Node.js. Note: this module cannot be used in the browser.

Why?

Writing JSON.stringify() and then fs.writeFile() and JSON.parse() with fs.readFile() enclosed in try/catch blocks became annoying.

Installation

API

readFile(filename, [options], callback)

options (object, default undefined): Pass in any fs.readFile options or set reviver for a JSON reviver.

• throws (boolean, default: true). If JSON.parse throws an error, pass this error to the callback. If false, returns null for the object.

You can also use this method with promises. The readFile method will return a promise if you do not pass a callback function.

readFileSync(filename, [options])

options (object, default undefined): Pass in any fs.readFileSync options or set reviver for a JSON reviver.

• throws (boolean, default: true). If an error is encountered reading or parsing the file, throw the error. If false, returns null for the object.

writeFile(filename, obj, [options], callback)

options: Pass in any fs.writeFile options or set replacer for a JSON replacer. Can also pass in spaces, or override EOL string or set finalEOL flag as false to not save the file with EOL at the end.

Or use with promises as follows:

formatting with spaces:

overriding EOL:

disabling the EOL at the end of file:

appending to an existing JSON file:

You can use fs.writeFile option { flag: 'a' } to achieve this.

writeFileSync(filename, obj, [options])

options: Pass in any fs.writeFileSync options or set replacer for a JSON replacer. Can also pass in spaces, or override EOL string or set finalEOL flag as false to not save the file with EOL at the end.

formatting with spaces:

overriding EOL:

disabling the EOL at the end of file:

appending to an existing JSON file:

You can use fs.writeFileSync option { flag: 'a' } to achieve this.

License

(MIT License)

Copyright 2012-2016, JP Richardson