Open In App

Node.js fs-extra ensureDirSync() function

Last Updated : 06 Oct, 2021
Improve
Improve
Like Article
Like
Save
Share
Report

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.
    1. Integer: If it is an integer it will be mode.
    2. 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:

  1. The module can be installed by using the following command.
    npm install fs-extra
  2. After the installation of the module you can check the version of the installed module by using this command.
    npm ls fs-extra

  3. 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');
  4. 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




// Requiring module
const fs = require("fs-extra");
  
// Function to check
// if directory  exists
// or not
const dirExists = (dir) => {
  if (fs.existsSync(dir)) {
    return "Directory exists";
  } else {
    return "Directory do not exist";
  }
};
  
// This directory
// already exists so
// function will not
// do anything
const dir = "dir";
  
// Checking before
// calling function
const before = dirExists(dir);
console.log(`Before function call ${before}`);
  
// Function call
fs.ensureDirSync(dir);
  
// Checking after
//  calling function
const after = dirExists(dir);
console.log(`After function call ${after}`);


Output:

Example 2:

index.js




// Requiring module
const fs = require("fs-extra");
  
// Function to check
// if directory  exists
// or not
const dirExists = (dir) => {
  if (fs.existsSync(dir)) {
    return "Directory exists";
  } else {
    return "Directory do not exist";
  }
};
  
// This directory
// do not  exists so
// function will create
// the directory
const dir = "direc/dir";
  
const mode = 0o2775;
  
// Checking before
// calling function
const before = dirExists(dir);
console.log(`Before function call ${before}`);
  
// Function call
fs.ensureDirSync(dir, mode);
  
// Checking after
//  calling function
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
Previous
Next
Share your thoughts in the comments

Similar Reads