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:

filter_none

edit
close

play_arrow

link
brightness_4
code

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

chevron_right


Output:

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

Example 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

// 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)

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.

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




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.