What is Node.js fs.Dirent.isFile() Method?

In this article, we will learn Node.js fs.Dirent.isFile() Method,This free Node.js tutorial for complete beginners will help you learn Node.js from scratch.

Node.js fs.Dirent.isFile() Method - ❤️Node.js Tutorials In 2024

The fs.Dirent.isFile() method is an inbuilt application programming interface of class fs.Dirent within File System module which is used to check if the particular dirent describes a File or not.

Syntax:

const dirent.isFile()

Parameter: This method does not accept any parameter.
Return Value: This method returns true if the particular dirent describes a File otherwise false.
Below programs illustrates the use of fs.dirent.isFile() method in node.js:
Example 1:
Filename: index.js

javascript

// Node.js program to demonstrate the 
// dirent.isFile() method
const fs = require('fs');
 
// Initiating async function
async function stop(path) {
 
  // Creating and initiating File's 
  // underlying resource handle
  const dir = await fs.promises.opendir(path);
   
  // Synchronously reading the File's
  // underlying resource handle
  // using readSync() method
  for(var i = 0; i <= 3; i ++ ) {
 
    // Checking if the particular dirent is
    // File  or not by using isFile() method
    const value = (dir.readSync()).isFile();
 
    // Display the result
    console.log(dir.readSync());
    console.log(value);
  }
}
 
// Catching error
stop('./').catch(console.error);

Run index.js file using the following command:

node index.js

Output:

Dirent { name: 'cert.cer', [Symbol(type)]: 1 }
true
Dirent { name: 'certificate1.cer', [Symbol(type)]: 1 }
true
Dirent { name: 'filename.txt', [Symbol(type)]: 1 }
false
Dirent { name: 'GFG.java', [Symbol(type)]: 1 }
true

Example 2:
Filename: index.js

javascript

// Node.js program to demonstrate the 
// dirent.isFile() method
const fs = require('fs');
   
// Initiating async function
async function stop(path) {
  
  let dir = null;
   
  try {
 
    // Creating and initiating directory's
    // underlying resource handle
    dir = await fs.promises.opendir(
        new URL('file:///F:/java/'));
 
    // Synchronously reading the File's
    // underlying resource handle
    // using readSync() method
    for(var i = 0; i <= 3; i ++ ) {
 
      // Checking if the particular dirent 
      // is File or not by using isFile() method
      const value = (dir.readSync()).isFile();
   
      // Display the result
     console.log(dir.readSync());
     console.log(value);
    }
  } finally {
  
    if (dir) {
 
      // Display the result
      console.log("dir is closed successfully");
 
      // Synchronously closeSyncing the 
      // directory's underlying resource
      // handle
      const promise = dir.closeSync();
    }
  }
}
   
// catching error
stop('./').catch(console.error);

Run index.js file using the following command:

node index.js

Output:

Dirent { name: 'cert.cer', [Symbol(type)]: 1 }
true
Dirent { name: 'certificate1.cer', [Symbol(type)]: 1 }
true
Dirent { name: 'features', [Symbol(type)]: 2 }
true
Dirent { name: 'GFG.class', [Symbol(type)]: 1 }
true
dir is closed successfully

Reference: https://nodejs.org/dist/latest-v12.x/docs/api/fs.html#fs_dirent_isfile