Node.js - file stats

In this article, we would like to show you how to get file stats in Node.js.

1. Import fs module in your project

const fs = require('fs');

2. Use fs.stat() to get the file stats.

In the example below, we print in the console example stats for .txt file with a callback function specified as fs.stat() method second argument.

const fs = require('fs');

fs.stat('./file.txt', (err, stats) => {
  if (err) {
    console.error(err);
    return;
  }

  console.log('isFile: ' + stats.isFile());                 //true
  console.log('isDirectory: ' + stats.isDirectory());       //false
  console.log('isSymbolicLink: ' + stats.isSymbolicLink()); //false
  console.log('size: ' + stats.size); // size in bytes
});

Example output for file.txt:

isFile: true
isDirectory: false
isSymbolicLink: false
size: 4

References

• File system | Node.js v16.9.1 Documentation