Node.js fs.Dirent.isSymbolicLink() Method

The fs.Dirent.isSymbolicLink() 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 SymbolicLink or not.

Syntax:

const dirent.isSymbolicLink()

Parameter: This method does not accept any parameter.

Return Value: This method returns true if the particular dirent describes a SymbolicLink otherwise false.

Below programs illustrates the use of fs.dirent.isSymbolicLink() method in Node.js:



Example 1:
Filename: index.js

filter_none

edit
close

play_arrow

link
brightness_4
code

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

chevron_right


Run index.js file using the following command:

node index.js

Output:

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

Example 2:
Filename: index.js

filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the 
// dirent.isSymbolicLink() method
const fs = require('fs');
    
// Initiating asyn 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 dir's 
    // underlying resource handle
    // using readSync() method
    for(var i = 0; i <= 3; i ++ ) {
  
      // Checking if the particular dirent
      // is SymbolicLink or not by using
      // isSymbolicLink() method
      const value = (dir.readSync()).isSymbolicLink();
    
      // 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);

chevron_right


Output:

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

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




My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.


Article Tags :

Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.