time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1394B)

      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 the entire contents of a file.
     23 *
     24 * @module @stdlib/fs/read-file
     25 *
     26 * @example
     27 * var readFile = require( '@stdlib/fs/read-file' );
     28 *
     29 * function onFile( error, data ) {
     30 *     if ( error ) {
     31 *         throw error;
     32 *     }
     33 *     console.log( data );
     34 * }
     35 * readFile( __filename, onFile );
     36 *
     37 * @example
     38 * var readFileSync = require( '@stdlib/fs/read-file' ).sync;
     39 *
     40 * var out = readFileSync( __filename );
     41 * if ( out instanceof Error ) {
     42 *     throw out;
     43 * }
     44 * console.log( out );
     45 */
     46 
     47 // MODULES //
     48 
     49 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     50 var readFile = require( './main.js' );
     51 var sync = require( './sync.js' );
     52 
     53 
     54 // MAIN //
     55 
     56 setReadOnly( readFile, 'sync', sync );
     57 
     58 
     59 // EXPORTS //
     60 
     61 module.exports = readFile;