README
Read JSON
Reads the entire contents of a JSON file.
Installation
$ npm install utils-fs-read-json
Usage
var readJSON = require( 'utils-fs-read-json' );
readJSON( path, [ options,] clbk )
Reads the entire contents of a JSON file.
readJSON( '/path/to/data.json', onData );
function onData( error, data ) {
if ( error ) {
console.error( error );
} else {
console.log( data );
}
}
The function accepts the same options as fs.readFile()
, but encoding
is always set to utf8
. In addition, a JSON reviver may be provided.
var opts = {
'reviver': reviver
};
readJSON( '/path/to/data.json', opts, onData );
function onData( error, data ) {
if ( error ) {
console.error( error );
} else {
console.log( data );
}
}
function reviver( key, value ) {
if ( key === 'beep' ) {
return 'boop';
}
return value;
}
readJSON.sync( path[, options] )
Synchronously reads the contents of an entire JSON file.
var out = readJSON.sync( '/path/to/data.json' );
if ( out instanceof Error ) {
throw out;
}
console.log( out );
The function accepts the same options as fs.readFileSync()
and the asynchronous readJSON
method above.
Examples
var path = require( 'path' ),
readJSON = require( 'utils-fs-read-json' );
var file = path.join( __dirname, 'data.json' );
// Sync:
var data = readJSON.sync( file, 'utf8' );
// returns <object>
console.log( data instanceof Error );
// returns false
data = readJSON.sync( 'beepboop', {
'encoding': 'utf8'
});
// returns <error>
console.log( data instanceof Error );
// returns true
// Async:
readJSON( file, onJSON );
readJSON( 'beepboop', onJSON );
function onJSON( error, data ) {
if ( error ) {
if ( error.code === 'ENOENT' ) {
console.error( 'JSON file does not exist.' );
} else {
throw error;
}
} else {
console.log( 'Beep: %s.', data.beep );
}
}
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. Athan Reines.