62 lines
1.4 KiB
JavaScript
62 lines
1.4 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Read the entire contents of a file.
|
||
|
|
*
|
||
|
|
* @module @stdlib/fs/read-file
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var readFile = require( '@stdlib/fs/read-file' );
|
||
|
|
*
|
||
|
|
* function onFile( error, data ) {
|
||
|
|
* if ( error ) {
|
||
|
|
* throw error;
|
||
|
|
* }
|
||
|
|
* console.log( data );
|
||
|
|
* }
|
||
|
|
* readFile( __filename, onFile );
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var readFileSync = require( '@stdlib/fs/read-file' ).sync;
|
||
|
|
*
|
||
|
|
* var out = readFileSync( __filename );
|
||
|
|
* if ( out instanceof Error ) {
|
||
|
|
* throw out;
|
||
|
|
* }
|
||
|
|
* console.log( out );
|
||
|
|
*/
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
|
||
|
|
var readFile = require( './main.js' );
|
||
|
|
var sync = require( './sync.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
setReadOnly( readFile, 'sync', sync );
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = readFile;
|