time-to-botec

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

index.js (3259B)

      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 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
     23 */
     24 
     25 // MODULES //
     26 
     27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
     28 
     29 
     30 // MAIN //
     31 
     32 /**
     33 * Top-level namespace.
     34 *
     35 * @namespace fs
     36 */
     37 var fs = {};
     38 
     39 /**
     40 * @name close
     41 * @memberof fs
     42 * @readonly
     43 * @type {Function}
     44 * @see {@link module:@stdlib/fs/close}
     45 */
     46 setReadOnly( fs, 'close', require( './../close' ) );
     47 
     48 /**
     49 * @name exists
     50 * @memberof fs
     51 * @readonly
     52 * @type {Function}
     53 * @see {@link module:@stdlib/fs/exists}
     54 */
     55 setReadOnly( fs, 'exists', require( './../exists' ) );
     56 
     57 /**
     58 * @name open
     59 * @memberof fs
     60 * @readonly
     61 * @type {Function}
     62 * @see {@link module:@stdlib/fs/open}
     63 */
     64 setReadOnly( fs, 'open', require( './../open' ) );
     65 
     66 /**
     67 * @name readDir
     68 * @memberof fs
     69 * @readonly
     70 * @type {Function}
     71 * @see {@link module:@stdlib/fs/read-dir}
     72 */
     73 setReadOnly( fs, 'readDir', require( './../read-dir' ) );
     74 
     75 /**
     76 * @name readFile
     77 * @memberof fs
     78 * @readonly
     79 * @type {Function}
     80 * @see {@link module:@stdlib/fs/read-file}
     81 */
     82 setReadOnly( fs, 'readFile', require( './../read-file' ) );
     83 
     84 /**
     85 * @name readFileList
     86 * @memberof fs
     87 * @readonly
     88 * @type {Function}
     89 * @see {@link module:@stdlib/fs/read-file-list}
     90 */
     91 setReadOnly( fs, 'readFileList', require( './../read-file-list' ) );
     92 
     93 /**
     94 * @name readJSON
     95 * @memberof fs
     96 * @readonly
     97 * @type {Function}
     98 * @see {@link module:@stdlib/fs/read-json}
     99 */
    100 setReadOnly( fs, 'readJSON', require( './../read-json' ) );
    101 
    102 /**
    103 * @name readWASM
    104 * @memberof fs
    105 * @readonly
    106 * @type {Function}
    107 * @see {@link module:@stdlib/fs/read-wasm}
    108 */
    109 setReadOnly( fs, 'readWASM', require( './../read-wasm' ) );
    110 
    111 /**
    112 * @name rename
    113 * @memberof fs
    114 * @readonly
    115 * @type {Function}
    116 * @see {@link module:@stdlib/fs/rename}
    117 */
    118 setReadOnly( fs, 'rename', require( './../rename' ) );
    119 
    120 /**
    121 * @name resolveParentPath
    122 * @memberof fs
    123 * @readonly
    124 * @type {Function}
    125 * @see {@link module:@stdlib/fs/resolve-parent-path}
    126 */
    127 setReadOnly( fs, 'resolveParentPath', require( './../resolve-parent-path' ) );
    128 
    129 /**
    130 * @name resolveParentPathBy
    131 * @memberof fs
    132 * @readonly
    133 * @type {Function}
    134 * @see {@link module:@stdlib/fs/resolve-parent-path-by}
    135 */
    136 setReadOnly( fs, 'resolveParentPathBy', require( './../resolve-parent-path-by' ) );
    137 
    138 /**
    139 * @name unlink
    140 * @memberof fs
    141 * @readonly
    142 * @type {Function}
    143 * @see {@link module:@stdlib/fs/unlink}
    144 */
    145 setReadOnly( fs, 'unlink', require( './../unlink' ) );
    146 
    147 /**
    148 * @name writeFile
    149 * @memberof fs
    150 * @readonly
    151 * @type {Function}
    152 * @see {@link module:@stdlib/fs/write-file}
    153 */
    154 setReadOnly( fs, 'writeFile', require( './../write-file' ) );
    155 
    156 
    157 // EXPORTS //
    158 
    159 module.exports = fs;