What is Node.js fs.Dirent.isSocket() Method?

In this article, we will learn Node.js fs.Dirent.isSocket() Method,This free Node.js tutorial for complete beginners will help you learn Node.js from scratch.

Node.js fs.Dirent.isSocket() Method - ❤️Node.js Tutorials In 2024

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

Syntax:

const dirent.isSocket()

Parameter: This method does not accept any parameter.

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

Example 1: The below program illustrates the use of fs.dirent.isSocket() method in Node.js:

Filename: index.js

javascript

// Node.js program to demonstrate the
// dirent.isSocket() method
const fs = require('fs');
 
// Initiating async 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() method
    for (let i = 0; i <= 3; i++) {
 
        // Checking if the particular
        // dirent is Socket or not
        // by using isSocket() method
        const value = (
            dir.readSync()).isSocket();
 
        // Display the result
        console.log(dir.readSync());
        console.log(value);
    }
}
 
// Catching error
stop('./').catch(console.error);

Run the 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: The below program illustrates the use of fs.dirent.isSocket() method in Node.js:

Filename: index.js

javascript

// Node.js program to demonstrate the
// dirent.isSocket() method
const fs = require('fs');
 
// Initiating async 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() method
    for (let i = 0; i <= 3; i++) {
 
        // Checking if the particular
        // dirent is Socket or not
        // by using isSocket() method
        const value = (
            dir.readSync()).isSocket();
 
        // Display the result
        console.log(dir.readSync());
        console.log(value);
    }
}
 
// Catching error
stop('./').catch(console.error);

Run the 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: '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_issocket