The fsPromises.stat() method is used to return information about the given file or directory. The Promise is resolved with the fs.Stats object for the given path.
Syntax:
fsPromises.stat( path, options )
Parameters: This method accept two parameters as mentioned above and described below:
- path: It holds the path of the file or directory that has to be checked. It can be a String, Buffer or URL.
-
options: It is an object that can be used to specify optional parameters that will affect the output. It has one optional parameter:
- bigint: It is a boolean value which specifies if the numeric values returned in the fs.Stats object are bigint. The default value is false.
Below examples illustrate the fsPromises.stat() method in Node.js:
Example 1: This example uses fsPromises.stat() method to get the details of the path.
// Node.js program to demonstrate the // fsPromises.stat() method // Import the filesystem module const fsPromises = require( "fs" ).promises;
(async () => { try {
await fsPromises.rename( "GFG.txt" ,
"GeeksforGeeks.txt" );
// Using the fsPromises.stat() method
const stats = await fsPromises.stat(
"GeeksforGeeks.txt" );
console.log(stats);
}
catch (error) {
console.log(error);
}
})(); |
Output:
Stats { dev: 654202934, mode: 85416, nlink: 1, uid: 0, gid: 0, rdev: 0, blksize: undefined, ino: 6192449489177455, size: 0, blocks: undefined, atimeMs: 5126587454188, mtimeMs: 8845632838067, ctimeMs: 5214789541254.1998, birthtimeMs: 1572568634187.734, atime: 2020-06-10T00:25:14.198ZZ, mtime: 2020-06-10T00:38:38.068Z, ctime: 2020-06-10T00:38:47.450Z, birthtime: 2020-06-101T00:25:14.198Z }
Example 2: This example uses fsPromises.stat() method to get the details of files with the bigint option:
// Node.js program to demonstrate the // fsPromises.stat() method // Import the filesystem module const fsPromises = require( "fs" ).promises;
(async () => { try {
await fsPromises.rename( "GFG.txt" ,
"GeeksforGeeks.txt" );
// Using the fsPromises.stat() method
const stats = await fsPromises.stat(
( "GeeksforGeeks.txt" ), {bigint: true });
console.log(stats);
}
catch (error) {
console.log(error);
}
})(); |
Output:
Stats { dev: 2269, mode: 33188, nlink: 1, uid: 1000, gid: 1000, rdev: 0, blksize: 4096, ino: 271, size: 0, blocks: 0, atimeMs: 1582871562365.894, mtimeMs: 1582871556897.5554, ctimeMs: 1582871556897.5554, birthtimeMs: 1582871556897.5554, atime: 2020-02-28T06:32:42.366Z, mtime: 2020-02-28T06:32:36.898Z, ctime: 2020-02-28T06:32:36.898Z, birthtime: 2020-02-28T06:32:36.898Z }
Reference: https://nodejs.org/api/fs.html#fs_fspromises_stat_path_options