time-to-botec/js/node_modules/@stdlib/fs/read-file/lib/sync.js

62 lines
1.5 KiB
JavaScript
Raw Normal View History

/**
* @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';
// MODULES //
var readfileSync = require( 'fs' ).readFileSync; // eslint-disable-line no-sync
// MAIN //
/**
* Synchronously reads the entire contents of a file.
*
* @param {(string|Buffer|integer)} file - file path or file descriptor
* @param {(Object|string)} [options] - options
* @param {(string|null)} [options.encoding] - file encoding
* @param {string} [options.flag] - file status flag
* @returns {(Buffer|string|Error)} file contents or an error
*
* @example
* var out = readFileSync( __filename );
* if ( out instanceof Error ) {
* throw out;
* }
* console.log( out );
*/
function readFileSync( file, options ) {
var f;
try {
if ( arguments.length > 1 ) {
f = readfileSync( file, options );
} else {
f = readfileSync( file );
}
} catch ( err ) {
return err;
}
return f;
}
// EXPORTS //
module.exports = readFileSync;