sync.js (1629B)
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 close = require( 'fs' ).closeSync; // eslint-disable-line no-sync, stdlib/no-redeclare 24 var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; 25 26 27 // MAIN // 28 29 /** 30 * Synchronously closes a file descriptor. 31 * 32 * @param {NonNegativeInteger} fd - file descriptor 33 * @throws {TypeError} must provide a valid file descriptor (nonnegative integer) 34 * @returns {(Error|void)} an error object or `undefined` 35 * 36 * @example 37 * var openSync = require( '@stdlib/fs/open' ).sync; 38 * 39 * var fd = openSync( __filename, 'r+' ); 40 * 41 * if ( fd instanceof Error ) { 42 * throw fd; 43 * } 44 * 45 * var err = closeSync( fd ); 46 * if ( err instanceof Error ) { 47 * throw err; 48 * } 49 */ 50 function closeSync( fd ) { 51 if ( !isNonNegativeInteger( fd ) ) { 52 throw new TypeError( 'invalid argument. Must provide a valid file descriptor (nonnegative integer). Value: `' + fd + '`.' ); 53 } 54 try { 55 close( fd ); 56 } catch ( err ) { 57 return err; 58 } 59 } 60 61 62 // EXPORTS // 63 64 module.exports = closeSync;