time-to-botec

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

index.js (1512B)

      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 each file in a file list.
     23 *
     24 * @module @stdlib/fs/read-file-list
     25 *
     26 * @example
     27 * var readFileList = require( '@stdlib/fs/read-file-list' );
     28 *
     29 * var list = [ __filename ];
     30 *
     31 * readFileList( list, onFiles );
     32 *
     33 * function onFiles( error, files ) {
     34 *     if ( error ) {
     35 *         throw error;
     36 *     }
     37 *     console.dir( files );
     38 * }
     39 *
     40 * @example
     41 * var readFileList = require( '@stdlib/fs/read-file-list' ).sync;
     42 *
     43 * var list = [ __filename ];
     44 * var files = readFileList( list );
     45 *
     46 * if ( files instanceof Error ) {
     47 *     throw files;
     48 * }
     49 * console.dir( files );
     50 */
     51 
     52 // MODULES //
     53 
     54 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     55 var readFileList = require( './async.js' );
     56 var sync = require( './sync.js' );
     57 
     58 
     59 // MAIN //
     60 
     61 setReadOnly( readFileList, 'sync', sync );
     62 
     63 
     64 // EXPORTS //
     65 
     66 module.exports = readFileList;