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:

// 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");
    }
});

Output:

fs.Stats does not describe a symbolic link

Example 2:

// 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());
});

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