Node.js stats.isFile() Method from fs.Stats Class

The stats.isFile() method is an inbuilt application programming interface of the fs.Stats class which is used to check whether fs.Stats object describes a file or not.

Syntax:

stats.isFile();

Parameters: This method does not accept any parameters.

Return Value: This method returns a boolean value, which is true if fs.Stats object describes a file, false otherwise.

Below examples illustrate the use of stats.isFile() method in Node.js:

Example 1:

// Node.js program to demonstrate the
// stats.isFile() method

// Accessing fs module
const fs = require('fs');

// Calling fs.Stats isFile() method
fs.stat('./filename.txt', (err, stats) => {
    if (err) throw err;

    // console.log(`stats: ${JSON.stringify(stats)}`);
    console.log(stats.isFile());
});


fs.stat('./filename.txt', (err, stats) => {
    if (err) throw err;

    // console.log(`stats: ${JSON.stringify(stats)}`);
    if (stats.isFile()) {
        console.log("fs.Stats describes a file");
    } else {
        console.log("fs.Stats does not describe a file");
    }
});

Output:

true
fs.Stats describes a file

Example 2:

// Node.js program to demonstrate the
// stats.isFile() method

// Accessing fs module
const fs = require('fs');

// Calling fs.Stats isFile() method
fs.stat('./', (err, stats) => {
    if (err) throw err;

    // console.log(`stats: ${JSON.stringify(stats)}`);
    console.log(stats.isFile());
});

fs.stat('./', (err, stats) => {
    if (err) throw err;

    // console.log(`stats: ${JSON.stringify(stats)}`);
    if (stats.isFile()) {
        console.log("fs.Stats describes a file");
    } else {
        console.log("fs.Stats does not describe a file");
    }
});

Output:

false
fs.Stats does not describe a file

Note: The above program will compile and run by using the node filename.js command and use the file_path correctly.

Reference: https://nodejs.org/api/fs.html#fs_stats_isfile