Node.js | stats.isSymbolicLink() Method

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

Syntax:

stats.isSymbolicLink();

Parameters: This method does not accept any parameter.

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

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



Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the   
// stats.isSymbolicLink() Method
  
// Accessing fs module
const fs = require('fs').promises;
  
// Accessing fs module
const fs = require('fs');
  
// Calling fs.Stats isSymbolicLink()
fs.lstat('./filename.lnk', (err, stats) => {
    if (err) throw err;
    if (stats.isSymbolicLink()) {
        console.log("fs.Stats describes "
                    + "a symbolic link");
    } else {
        console.log("fs.Stats does not "
            + "describe a symbolic link");
    }
});

chevron_right


Output:

fs.Stats does not describe a symbolic link

Example 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the   
// stats.isSymbolicLink() Method
  
// Accessing fs module
const fs = require('fs');
  
// Calling isSymbolicLink() method from
// fs.Stats class
fs.lstat('./filename.lnk', (err, stats) => {
    if (err) throw err;
    console.log(stats.isSymbolicLink());
});

chevron_right


Output:

false

Note: The above program will compile and run by using the node filename.js command and use the file_path correctly. Use the symbolic link in UNIX based system It will return true.

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




My Personal Notes arrow_drop_up

I am a programmer by hobby

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.