index.js (1588B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Read a file as JSON. 23 * 24 * @module @stdlib/fs/read-json 25 * 26 * @example 27 * var resolve = require( 'path' ).resolve; 28 * var readJSON = require( '@stdlib/fs/read-json' ); 29 * 30 * function onJSON( error, data ) { 31 * if ( error ) { 32 * throw error; 33 * } 34 * console.dir( data ); 35 * } 36 * 37 * readJSON( resolve( __dirname, '..', 'package.json' ), onJSON ); 38 * 39 * @example 40 * var resolve = require( 'path' ).resolve; 41 * var instanceOf = require( '@stdlib/assert/instance-of' ); 42 * var readJSON = require( '@stdlib/fs/read-json' ); 43 * 44 * var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) ); 45 * if ( instanceOf( out, Error ) ) { 46 * throw out; 47 * } 48 * console.dir( out ); 49 */ 50 51 // MODULES // 52 53 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 54 var readJSON = require( './async.js' ); 55 var sync = require( './sync.js' ); 56 57 58 // MAIN // 59 60 setReadOnly( readJSON, 'sync', sync ); 61 62 63 // EXPORTS // 64 65 module.exports = readJSON;