sync.js (1490B)
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 // MODULES // 22 23 var readfileSync = require( 'fs' ).readFileSync; // eslint-disable-line no-sync 24 25 26 // MAIN // 27 28 /** 29 * Synchronously reads the entire contents of a file. 30 * 31 * @param {(string|Buffer|integer)} file - file path or file descriptor 32 * @param {(Object|string)} [options] - options 33 * @param {(string|null)} [options.encoding] - file encoding 34 * @param {string} [options.flag] - file status flag 35 * @returns {(Buffer|string|Error)} file contents or an error 36 * 37 * @example 38 * var out = readFileSync( __filename ); 39 * if ( out instanceof Error ) { 40 * throw out; 41 * } 42 * console.log( out ); 43 */ 44 function readFileSync( file, options ) { 45 var f; 46 try { 47 if ( arguments.length > 1 ) { 48 f = readfileSync( file, options ); 49 } else { 50 f = readfileSync( file ); 51 } 52 } catch ( err ) { 53 return err; 54 } 55 return f; 56 } 57 58 59 // EXPORTS // 60 61 module.exports = readFileSync;