diff --git a/doc/api/fs.md b/doc/api/fs.md index 01b7b01982895a..772d1dc8e4f9af 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -3020,6 +3020,76 @@ error raised if the file is not available. To check if a file exists without manipulating it afterwards, [`fs.access()`] is recommended. +For example, given the following folder structure: + +```fundamental +- txtDir +-- file.txt +- app.js +``` + +The next program will check for the stats of the given paths: + +```js +const fs = require('fs'); + +const pathsToCheck = ['./txtDir', './txtDir/file.txt']; + +for (let i = 0; i < pathsToCheck.length; i++) { + fs.stat(pathsToCheck[i], function(err, stats) { + console.log(stats.isDirectory()); + console.log(stats); + }); +} +``` + +The resulting output will resemble: + +```console +true +Stats { + dev: 16777220, + mode: 16877, + nlink: 3, + uid: 501, + gid: 20, + rdev: 0, + blksize: 4096, + ino: 14214262, + size: 96, + blocks: 0, + atimeMs: 1561174653071.963, + mtimeMs: 1561174614583.3518, + ctimeMs: 1561174626623.5366, + birthtimeMs: 1561174126937.2893, + atime: 2019-06-22T03:37:33.072Z, + mtime: 2019-06-22T03:36:54.583Z, + ctime: 2019-06-22T03:37:06.624Z, + birthtime: 2019-06-22T03:28:46.937Z +} +false +Stats { + dev: 16777220, + mode: 33188, + nlink: 1, + uid: 501, + gid: 20, + rdev: 0, + blksize: 4096, + ino: 14214074, + size: 8, + blocks: 8, + atimeMs: 1561174616618.8555, + mtimeMs: 1561174614584, + ctimeMs: 1561174614583.8145, + birthtimeMs: 1561174007710.7478, + atime: 2019-06-22T03:36:56.619Z, + mtime: 2019-06-22T03:36:54.584Z, + ctime: 2019-06-22T03:36:54.584Z, + birthtime: 2019-06-22T03:26:47.711Z +} +``` + ## fs.statSync(path[, options])