All files index.js

100% Statements 84/84
100% Branches 1/1
100% Functions 0/0
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 857x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x 7x  
/**
* @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';
 
/**
* Return full details on the statistics of a file or directory. For more information, see the [archive][1].
*
* [1]: https://github.com/nodejs/node-v0.x-archive/blob/d8baf8a2a4481940bfed0196308ae6189ca18eee/lib/fs.js#L782
*
* @module @stdlib/fs/stat
*
* @example
* var stat = require( '@stdlib/fs/stat' );
*
* stat( __filename, onStat );
* stat( __dirname, onStat );
*
* function onStat( error, stats ) {
*   if ( error ) {
*     throw error;
*   }
*   console.log( stats.isFile() );
*   console.log( stats.isDirectory() );
*   console.log( stats.isSocket() );
*   console.log( stats.isSymbolicLink() );
*   console.log( stats.size );
*   console.log( stats.mode );
*   console.log( stats.atimeMs );
*   console.log( stats );
* }
*
* @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 );
*/
 
// MODULES //
 
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var stat = require( './async.js' );
var sync = require( './sync.js' );
 
 
// MAIN //
 
setReadOnly( stat, 'sync', sync );
 
 
// EXPORTS //
 
module.exports = stat;