Node.js fs-extra ensureDirSync() function
Last Updated :
06 Oct, 2021
The ensureDirSync() function is the synchronous version of ensureDir() function. The function makes sure that the directory exists, if the directory structure does not exist it will be created by the function. mkdirsSync() and mkdirpSync() can also be used in place of ensureDirSync() and the result will be same.
Syntax:
ensureDirSync(dir,options)
// OR
mkdirsSync(dir,options)
// OR
mkdirpSync(dir,options)
Parameters:
- dir: It is a string that contains the directory path.
- options: It is an object or an integer that is used to specify the optional parameters.
- Integer: If it is an integer it will be mode.
- Object: If it is an object it will be {mode: integer}.
Return value: It does not return anything.
Follow the steps to implement the function:
- The module can be installed by using the following command.
npm install fs-extra
- After the installation of the module you can check the version of the installed module by using this command.
npm ls fs-extra
- Create a file with the name index.js and require the fs-extra module in the file using the following command.
const fs = require('fs-extra');
- To run the file write the following command in the terminal.
node index.js
Project Structure: The project structure will look like this.
Example 1:
index.js
const fs = require( "fs-extra" );
const dirExists = (dir) => {
if (fs.existsSync(dir)) {
return "Directory exists" ;
} else {
return "Directory do not exist" ;
}
};
const dir = "dir" ;
const before = dirExists(dir);
console.log(`Before function call ${before}`);
fs.ensureDirSync(dir);
const after = dirExists(dir);
console.log(`After function call ${after}`);
|
Output:
Example 2:
index.js
const fs = require( "fs-extra" );
const dirExists = (dir) => {
if (fs.existsSync(dir)) {
return "Directory exists" ;
} else {
return "Directory do not exist" ;
}
};
const dir = "direc/dir" ;
const mode = 0o2775;
const before = dirExists(dir);
console.log(`Before function call ${before}`);
fs.ensureDirSync(dir, mode);
const after = dirExists(dir);
console.log(`After function call ${after}`);
|
Output:
Reference: https://github.com/jprichardson/node-fs-extra/blob/HEAD/docs/ensureDir-sync.md
Like Article
Suggest improvement
Share your thoughts in the comments
Please Login to comment...