time-to-botec

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

index.js (1424B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2019 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 * Open a file.
     23 *
     24 * @module @stdlib/fs/open
     25 *
     26 * @example
     27 * var closeSync = require( '@stdlib/fs/close' ).sync;
     28 * var open = require( '@stdlib/fs/open' );
     29 *
     30 * function onOpen( error, fd ) {
     31 *     if ( error ) {
     32 *         throw error;
     33 *     }
     34 *     closeSync( fd );
     35 * }
     36 * open( __filename, onOpen );
     37 *
     38 * @example
     39 * var closeSync = require( '@stdlib/fs/close' ).sync;
     40 * var openSync = require( '@stdlib/fs/open' ).sync;
     41 *
     42 * var fd = openSync( __filename );
     43 * if ( fd instanceof Error ) {
     44 *     throw fd;
     45 * }
     46 * closeSync( fd );
     47 */
     48 
     49 // MODULES //
     50 
     51 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     52 var main = require( './main.js' );
     53 var sync = require( './sync.js' );
     54 
     55 
     56 // MAIN //
     57 
     58 setReadOnly( main, 'sync', sync );
     59 
     60 
     61 // EXPORTS //
     62 
     63 module.exports = main;