.. | ||
.npmignore | ||
appveyor.yml | ||
CHANGELOG.md | ||
index.js | ||
LICENSE | ||
package.json | ||
README.md |
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 = require('jsonfile')
var file = '/tmp/data.json'
jsonfile.readFile(file, function(err, obj) {
console.dir(obj)
})
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 = require('jsonfile')
var file = '/tmp/data.json'
console.dir(jsonfile.readFileSync(file))
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 = require('jsonfile')
var file = '/tmp/data.json'
var obj = {name: 'JP'}
jsonfile.writeFile(file, obj, function (err) {
console.error(err)
})
formatting with spaces:
var jsonfile = require('jsonfile')
var file = '/tmp/data.json'
var obj = {name: 'JP'}
jsonfile.writeFile(file, obj, {spaces: 2}, function(err) {
console.error(err)
})
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 = require('jsonfile')
var file = '/tmp/data.json'
var obj = {name: 'JP'}
jsonfile.writeFileSync(file, obj)
formatting with spaces:
var jsonfile = require('jsonfile')
var file = '/tmp/data.json'
var obj = {name: 'JP'}
jsonfile.writeFileSync(file, obj, {spaces: 2})
spaces
Global configuration to set spaces to indent JSON files.
default: null
var jsonfile = require('jsonfile')
jsonfile.spaces = 4
var file = '/tmp/data.json'
var obj = {name: 'JP'}
// json file has four space indenting now
jsonfile.writeFile(file, obj, function (err) {
console.error(err)
})
Note, it's bound to this.spaces
. So, if you do this:
var myObj = {}
myObj.writeJsonSync = jsonfile.writeFileSync
// => this.spaces = null
Could do the following:
var jsonfile = require('jsonfile')
jsonfile.spaces = 4
jsonfile.writeFileSync(file, obj) // will have 4 spaces indentation
var myCrazyObj = {spaces: 32}
myCrazyObj.writeJsonSync = jsonfile.writeFileSync
myCrazyObj.writeJsonSync(file, obj) // will have 32 space indentation
myCrazyObj.writeJsonSync(file, obj, {spaces: 2}) // will have only 2
License
(MIT License)
Copyright 2012-2016, JP Richardson jprichardson@gmail.com