@stdlib/fs-read-json
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    Read JSON

    NPM version Build Status Coverage Status dependencies

    Read a file as JSON.

    Installation

    npm install @stdlib/fs-read-json

    Usage

    var readJSON = require( '@stdlib/fs-read-json' );

    readJSON( file[, options], clbk )

    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 );
    }

    readJSON.sync( file[, options] )

    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.

    Notes

    • If the encoding option is set to utf8 and the file has a UTF-8 byte order mark (BOM), the byte order mark is removed before attempting to parse as JSON.

    Examples

    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 );
        }
    }

    Notice

    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.

    Community

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/fs-read-json

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    156

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    52.1 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser