time-to-botec

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

index.js (1411B)

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