time-to-botec

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

main.js (1891B)

      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 // MODULES //
     22 
     23 var native = require( 'fs' ).close;
     24 var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
     25 var isFunction = require( '@stdlib/assert/is-function' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Asynchronously closes a file descriptor.
     32 *
     33 * @param {NonNegativeInteger} fd - file descriptor
     34 * @param {Function} clbk - callback to invoke after closing a file descriptor
     35 * @throws {TypeError} first argument must be a valid file descriptor (nonnegative integer)
     36 * @throws {TypeError} last argument must be a function
     37 *
     38 * @example
     39 * var openSync = require( '@stdlib/fs/open' ).sync;
     40 *
     41 * function done( error ) {
     42 *     if ( error ) {
     43 *         throw error;
     44 *     }
     45 * }
     46 *
     47 * var fd = openSync( __filename, 'r+' );
     48 * if ( fd instanceof Error ) {
     49 *     throw fd;
     50 * }
     51 *
     52 * close( fd, done );
     53 */
     54 function close( fd, clbk ) { // eslint-disable-line stdlib/no-redeclare
     55 	if ( !isNonNegativeInteger( fd ) ) {
     56 		throw new TypeError( 'invalid argument. First argument must be a valid file descriptor (nonnegative integer). Value: `' + fd + '`.' );
     57 	}
     58 	if ( !isFunction( clbk ) ) {
     59 		throw new TypeError( 'invalid argument. Last argument must be a function. VAlue: `' + clbk + '`.' );
     60 	}
     61 	native( fd, clbk );
     62 }
     63 
     64 
     65 // EXPORTS //
     66 
     67 module.exports = close;