utils-fs-read-json

Read JSON
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]

> Reads the entire contents of a JSON file.

Installation

`` bash
$ npm install utils-fs-read-json
`

Usage

` javascript
var readJSON = require( 'utils-fs-read-json' );
`

#### readJSON( path, [ options,] clbk )

Reads the entire contents of a JSON file.

` javascript
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.

` javascript
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.

` javascript
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

` javascript
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