Read a file as JSON.
npm install @stdlib/fs-read-jsonAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var readJSON = require( '@stdlib/fs-read-json' );Asynchronously reads a file as JSON.
var join = require( 'path' ).join;
readJSON( join( __dirname, 'package.json' ), onJSON );
function onJSON( error, data ) {
if ( error ) {
throw error;
}
console.dir( data );
}The function accepts the following options:
- encoding: file encoding.
- flag: file status flag.
- reviver: JSON transformation
function.
The options parameter may also be a string specifying the file encoding.
var join = require( 'path' ).join;
readJSON( join( __dirname, 'package.json' ), 'utf8', onJSON );
function onJSON( error, data ) {
if ( error ) {
throw error;
}
console.dir( data );
}Synchronously reads a file as JSON.
var join = require( 'path' ).join;
var instanceOf = require( '@stdlib/assert-instance-of' );
var out = readJSON.sync( join( __dirname, 'package.json' ) );
if ( instanceOf( out, Error ) ) {
throw out;
}
console.dir( out );The function accepts the same options as readJSON() above.
- If the
encodingoption is set toutf8and the file has a UTF-8 byte order mark (BOM), the byte order mark is removed before attempting to parse as JSON.
var join = require( 'path' ).join;
var readJSON = require( '@stdlib/fs-read-json' );
var file = join( __dirname, 'package.json' );
// Synchronously read file contents...
var data = readJSON.sync( file, 'utf8' );
// returns <Object>
data = readJSON.sync( 'beepboop', {
'encoding': 'utf8'
});
// returns <Error>
// Asynchronously read file contents...
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( 'Package description: %s', data.description );
}
}@stdlib/fs-read-file: read the entire contents of a file.
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
