The fsPromises.opendir() method is used to asynchronously open a directory in the file system. It creates an fs.Dir, which contains all further functions for reading from and cleaning up the directory. This object contains various methods that can be used to accessing the directory.
Syntax:
fsPromises.opendir( path[, options])
Parameters: This method accepts two parameters as mentioned above and described below:
- path: It is a String, Buffer or URL that denotes the path of the directory that has to be opened.
-
options: It is an String or an object that can be used to specify optional parameters that will affect the output. It has two optional parameters:
- encoding: It is a string that specifies the encoding for the path when opening the directory and for subsequent read operations. The default value is ‘utf8’.
- bufferSize: It is a number that specifies the number of directory entries that are buffered internally when the directory is being read. A higher value means more performance but leads to higher memory usage. The default value is ’32’.
Example: This example illustrates the fsPromises.opendir() method in Node.js.
Filename: index.js
// Node.js program to demonstrate the // fsPromises.opendir() method // Import the filesystem module const fs = require('fs');
const fsPromises = fs.promises; fsPromises.opendir(__dirname) .then(function(result) {
console.log(result);
}) .catch(function(error) {
console.log(error);
}); |
Step to run this program:
Run index.js file using the following command:
node index.js
Output:
Dir {
[Symbol(kDirHandle)]: DirHandle {},
[Symbol(kDirBufferedEntries)]: [],
[Symbol(kDirPath)]: 'C:\\Users\\Lenovo\\Downloads\\Internship\\Program',
[Symbol(kDirClosed)]: false,
[Symbol(kDirOptions)]: { bufferSize: 32, encoding: 'utf8' },
[Symbol(kDirReadPromisified)]: [Function: bound [kDirReadImpl]],
[Symbol(kDirClosePromisified)]: [Function: bound close]
}
Reference: https://nodejs.org/api/fs.html#fs_fspromises_opendir_path_options