Node.js stat.isSocket() Method

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

Syntax:

stats.isSocket();

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 socket, false otherwise.

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

Example 1:

// Node.js program to demonstrate the
// stat.isSocket() Method

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

// Calling isSocket() method from fs.Stats
// class using lstat() method
fs.lstat('./', (err, stats) => {
    if (err) throw err;

    // console.log(`stats: ${JSON.stringify(stats)}`);
    console.log(stats.isSocket());
    if (stats.isSocket()) {
        console.log("fs.lstats describes a Socket.");
    } else {
        console.log("fs.lstats does not describe a socket.");
    }
});

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

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

Output:

false
fs.lstats does not describe a socket.
false
fs.stats does not describe a socket.

Example 2:

// Node.js program to demonstrate the
// stat.isSocket() Method

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

// Calling isSocket() method from
// fs.Stats class
(async () => {
    const stat = await fs.lstat('./');
    console.log(stat.isSocket());
})().catch(console.error)

Output:

false

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_issocket