All files sync.js

100% Statements 84/84
100% Branches 8/8
100% Functions 1/1
100% Lines 84/84

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 8511x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 9x 9x 9x 9x 9x 9x 9x 5x 9x 4x 1x 1x 3x 3x 9x 3x 3x 6x 9x 11x 11x 11x 11x 11x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var stat = require( 'fs' ).statSync; // eslint-disable-line node/no-sync
var isObject = require( '@stdlib/assert/is-plain-object' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Synchronously returns full details on the statistics of a file or directory.
*
* @param {(string|Buffer)} path - file path
* @param {Object} [options] - function options (Node >=10.5.0)
* @param {boolean} [options.bigint=false] - whether to return `BigInt` numeric values
* @throws {TypeError} options argument must be an object
* @throws {TypeError} options are not supported by the current environment
* @returns {(Stats|Error)} file statistics or an error
*
* @example
* var stat = require( '@stdlib/fs/stat' );
*
* var out = stat.sync( __filename );
* if ( out instanceof Error ) {
*     throw out;
* }
* console.log( out.isFile() );
* console.log( out.isSocket() );
* console.log( out.size );
* console.log( out );
*
* out = stat.sync( __dirname );
* if ( out instanceof Error ) {
*     throw out;
* }
* console.log( out.isDirectory() );
* console.log( out.isSymbolicLink() );
* console.log( out.mode );
* console.log( out );
*/
function statSync( path, options ) {
	var nargs;
	var out;
 
	nargs = arguments.length;
	try {
		if ( nargs === 1 ) {
			out = stat( path );
		} else {
			if ( !isObject( options ) ) {
				throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
			}
			out = stat( path, options );
		}
	} catch ( err ) {
		return err;
	}
	return out;
}
 
 
// EXPORTS //
 
module.exports = statSync;