How to use Node to interact with folders
Node.jsfs
The core module provides many convenient methods that can be used to process folders.
Check if the folder exists
usefs.access()
Check if the folder exists and Node can access it with its permissions.
Create a new folder
usefs.mkdir()
orfs.mkdirSync()
Create a new folder.
const fs = require('fs')
const folderName = ‘/Users/flavio/test’
try {
if (!fs.existsSync(dir)){
fs.mkdirSync(dir)
}
} catch (err) {
console.error(err)
}
Read the contents of the directory
usefs.readdir()
orfs.readdirSync
Read the contents of the directory.
This code reads the contents of folders, files and subfolders, and returns their relative paths:
const fs = require('fs')
const path = require('path')
const folderPath = ‘/Users/flavio’
fs.readdirSync(folderPath)
You can get the full path:
fs.readdirSync(folderPath).map(fileName => {
return path.join(folderPath, fileName)
}
You can also filter the results to return only files and exclude folders:
const isFile = fileName => {
return fs.lstatSync(fileName).isFile()
}
fs.readdirSync(folderPath).map(fileName => {
return path.join(folderPath, fileName)
}).filter(isFile)
Rename folder
usefs.rename()
orfs.renameSync()
Rename the folder. The first parameter is the current path, and the second parameter is the new path:
const fs = require('fs')
fs.rename(’/Users/flavio’, ‘/Users/roger’, err => {
if (err) {
console.error(err)
return
}
//done
})
fs.renameSync()
Is the synchronous version:
const fs = require('fs')
try {
fs.renameSync(’/Users/flavio’, ‘/Users/roger’)
} catch (err) {
console.error(err)
}
Remove folder
usefs.rmdir()
orfs.rmdirSync()
Delete the folder.
Deleting a folder with content may be more complicated than you need.
In this case, I suggest you installfs-extra
Module, this module is very popular and well maintained, it is a direct replacement for this modulefs
Module to provide more functions on top of it.
under these circumstancesremove()
The method is what you want.
Install using
npm install fs-extra
And use it like this:
const fs = require('fs-extra')
const folder = ‘/Users/flavio’
fs.remove(folder, err => {
console.error(err)
})
It can also be used with promises:
fs.remove(folder).then(() => {
//done
}).catch(err => {
console.error(err)
})
Or use async / await:
async function removeFolder(folder) {
try {
await fs.remove(folder)
//done
} catch (err) {
console.error(err)
}
}
const folder = ‘/Users/flavio’
removeFolder(folder)
Download mine for freeNode.js manual
More node tutorials:
- Introduction to npm package manager
- Introduction to Node.js
- HTTP request using Axios
- Where to host Node.js applications
- Use Node.js to interact with Google Analytics API
- npx node package runner
- package.json guide
- Where does npm install packages?
- How to update Node.js
- How to use or execute packages installed with npm
- package-lock.json file
- Semantic version control using npm
- Should you submit the node_modules folder to Git?
- Update all Node dependencies to the latest version
- Use Node.js to parse JSON
- Find the installed version of the npm package
- Node.js flow
- Install an older version of the npm package
- Get the current folder in Node
- How to record objects in Node
- Use export to expose functions from Node files
- Difference between node and browser
- Use Node to make HTTP POST requests
- Use Node to get HTTP request body data
- Node buffer
- A brief history of Node.js
- How to install Node.js
- How much JavaScript do you need to know to use Node?
- How to use Node.js REPL
- Node, accepts parameters from the command line
- Use Node to output to the command line
- Accept input from the command line in Node
- Use `npm uninstall` to uninstall the npm package.
- npm global or local package
- npm dependencies and devDependencies
- Node.js event loop
- Understanding process.nextTick()
- Understanding setImmediate()
- Node event emitter
- Set up an HTTP server
- Use Node to make HTTP requests
- Node fs module
- HTTP request in Node using Axios
- Use Node to read files
- Node file path
- Write file with Node
- Node file statistics
- Use file descriptors in Node
- Use folders in Node
- Node path module
- Node http module
- Combine WebSockets with Node.js
- Basic knowledge of using MySQL and Node
- Error handling in Node.js
- Pug Guide
- How to read environment variables from Node.js
- How to exit from Node.js program
- Node os module
- Node event module
- Node, the difference between development and production
- How to check if a file exists in Node.js
- How to create an empty file in Node.js
- How to delete files using Node.js
- How to get the last update date of a file using Node.js
- How to determine whether the date is today in JavaScript
- How to write a JSON object to a file in Node.js
- Why use Node.js in the next project?
- Run web server from any folder
- How to use MongoDB with Node.js
- Use Chrome DevTools to debug Node.js applications
- What is pnpm?
- Node.js runtime v8 options list
- How to solve the "missing write access permission" error when using npm
- How to enable ES modules in Node.js
- How to use Node.js to generate child processes
- How to get the parsed body and the original body at the same time in Express
- How to handle file upload in Node.js
- What is the peer dependency in the node module?
- How to write a CSV file using Node.js
- How to use Node.js to read CSV files
- Node core module
- Use Node.js to increase the number of multiple folders at once
- How to print canvas to data URL
- How to create and save images using Node.js and Canvas
- How to download images using Node.js
- How to batch rename files in Node.js
- How to get the names of all files in a folder in Node
- How to use promise and wait function based on Node.js callback
- How to test NPM packages locally
- How to check the current Node.js version at runtime
- How to use Sequelize to interact with PostgreSQL
- Use Node.js to serve HTML pages
- How to solve the error that util.pump in Node.js is not a function