Node.js - jsonfile
Easily read/write JSON files.
Why?
Writing JSON.stringify()
and then fs.writeFile()
and JSON.parse()
with fs.readFile()
enclosed in try/catch
blocks became annoying.
Installation
npm install --save jsonfile
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
). IfJSON.parse
throws an error, pass this error to the callback. Iffalse
, returnsnull
for the object.
var jsonfile = var file = '/tmp/data.json'jsonfile
readFileSync(filename, [options])
options
(object
, default undefined
): Pass in any fs.readFileSync
options or set reviver
for a JSON reviver.
throws
(boolean
, default:true
). IfJSON.parse
throws an error, throw the error. Iffalse
, returnsnull
for the object.
var jsonfile = var file = '/tmp/data.json' consoledirjsonfile
writeFile(filename, obj, [options], callback)
options
: Pass in any fs.writeFile
options or set replacer
for a JSON replacer. Can also pass in spaces
.
var jsonfile = var file = '/tmp/data.json'var obj = name: 'JP' jsonfile
formatting with spaces:
var jsonfile = var file = '/tmp/data.json'var obj = name: 'JP' jsonfile
appending to an existing JSON file:
You can use fs.writeFile
option {flag: 'a'}
to achieve this.
var jsonfile = var file = '/tmp/mayAlreadyExistedData.json'var obj = name: 'JP' jsonfile
writeFileSync(filename, obj, [options])
options
: Pass in any fs.writeFileSync
options or set replacer
for a JSON replacer. Can also pass in spaces
.
var jsonfile = var file = '/tmp/data.json'var obj = name: 'JP' jsonfile
formatting with spaces:
var jsonfile = var file = '/tmp/data.json'var obj = name: 'JP' jsonfile
appending to an existing JSON file:
You can use fs.writeFileSync
option {flag: 'a'}
to achieve this.
var jsonfile = var file = '/tmp/mayAlreadyExistedData.json'var obj = name: 'JP' jsonfile
spaces
Global configuration to set spaces to indent JSON files.
default: null
var jsonfile = jsonfilespaces = 4 var file = '/tmp/data.json'var obj = name: 'JP' // json file has four space indenting nowjsonfile
Note, it's bound to this.spaces
. So, if you do this:
var myObj = {}myObjwriteJsonSync = jsonfilewriteFileSync// => this.spaces = null
Could do the following:
var jsonfile = jsonfilespaces = 4jsonfile // will have 4 spaces indentation var myCrazyObj = spaces: 32myCrazyObjwriteJsonSync = jsonfilewriteFileSyncmyCrazyObj // will have 32 space indentationmyCrazyObj // will have only 2
License
(MIT License)
Copyright 2012-2016, JP Richardson jprichardson@gmail.com