2. Tutorials
  3. Node.js — How to Rename a File

Node.js — How to Rename a File

Node.js ships with a file system module allowing you to interact with files on the local hard disk. The file system module fs provides two methods allowing you to rename files: Fs#rename and Fs#renameSync.

This tutorial shows you how to rename a file synchronously and asynchronously using Node.js’ fs core module.

Node.js Series Overview

  1. Increase the Memory Limit for Your Process
  2. Why You Should Add “node” in Your Travis Config
  3. Create a PDF from HTML with Puppeteer and Handlebars
  4. Create Your Own Custom Error
  5. Retrieve a Request’s IP Address in Node.js
  6. Detect the Node.js Version in a Running Process or App
  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  1. Filter Data in Streams
  1. Get Number of Seconds Since Epoch in JavaScript
  2. Get Tomorrow’s Date in JavaScript
  3. Increase a Date in JavaScript by One Week
  4. Add Seconds to a Date in Node.js and JavaScript
  5. Add Month(s) to a Date in JavaScript or Node.js
  1. How to Run an Asynchronous Function in Array.map()
  2. How to Reset and Empty an Array
  3. for…of vs. for…in Loops
  4. Clone/Copy an Array in JavaScript and Node.js
  5. Get an Array With Unique Values (Delete Duplicates)
  6. Sort an Array of Integers in JavaScript and Node.js
  7. Sort a Boolean Array in JavaScript, TypeScript, or Node.js
  8. Check If an Array Contains a Given Value in JavaScript or Node.js
  9. Add an Item to the Beginning of an Array in JavaScript or Node.js
  10. Append an Item at the End of an Array in JavaScript or Node.js
  11. How to Exit and Stop a for Loop in JavaScript and Node.js (Coming soon)
  12. Split an Array Into Smaller Array Chunks in JavaScript and Node.js
  13. How to Get an Index in a for…of Loop in JavaScript and Node.js (Coming soon)
  14. How to Exit, Stop, or Break an Array#forEach Loop in JavaScript or Node.js (Coming soon)
  1. Callback and Promise Support in your Node.js Modules
  2. Run Async Functions/Promises in Sequence
  3. Run Async Functions/Promises in Parallel
  4. Run Async Functions in Batches
  5. How to Fix “Promise resolver undefined is not a function” in Node.js or JavaScript
  6. Detect if Value Is a Promise in Node.js and JavaScript
  1. Human-Readable JSON.stringify() With Spaces and Line Breaks
  2. Write a JSON Object to a File
  3. Create a Custom “toJSON” Function in Node.js and JavaScript
  1. Extend Multiple Classes (Multi Inheritance)
  2. Retrieve the Class Name at Runtime in JavaScript and Node.js
  1. Generate a Random Number in Range With JavaScript/Node.js
  1. How to Merge Objects
  2. How to Check if an Object is Empty in JavaScript or Node.js
  3. How to CamelCase Keys of an Object in JavaScript or Node.js

Asynchronously Rename Files in Node.js

Node.js’ fs core module provides the Fs#rename method as an asynchronous/non-blocking way to rename files on disk. Non-blocking in this case means Node.js processes other operations while waiting for the hard disk to respond.

This rename supports callbacks by default. The callback support comes from the early days of Node.js where asynchronous operations were handled using callbacks.

Later, Node.js added support for promises and async/await. This tutorial assumes you’re using async/await for flow control of your code. That’s the reason the example uses the require('fs').promises exports available in Node.js v10.0.0 and later. These promise-based file system methods are usable with async/await.

The Fs#rename method expects two arguments:

  1. the old file path
  2. the new file path

At first, you may expect a file path and the new file name instead of two file paths as the arguments. Well, renaming a file is basically moving a file from one place to another. Even when not changing the directory. The underlying operation of renaming a file is the “move” from the previous name to the new one.

Here’s an example on how to rename a file in Node.js using the built-in fs module:

const Path = require('path')  
const { promises: Fs } = require('fs')

const oldPath = Path.join(__dirname, "oldFile.txt")  
const newPath = Path.join(__dirname, "newFile.txt")

await Fs.rename(oldPath, newPath)

Please notice: this method overwrites any existing file at newPath. In case the newPath points to an existing directory, this method throws an error.

Synchronously Rename Files

Node.js also comes with an Fs#renameSync method. This method blocks the Node.js event loop for other operations (because it waits for the hard disk) while renaming a file. Here’s an example showing you how to rename a file synchronously:

const Fs = require('fs')  
const Path = require('path')

const oldPath = Path.join(__dirname, "oldFile.txt")  
const newPath = Path.join(__dirname, "newFile.txt")

Fs.renameSync(oldPath, newPath)

Use the @supercharge/filesystem Package

I’m the maintainer of the @supercharge/filesystem package providing convenient file system utilities. Methods in the @supercharge/filesystem package are async by default and don’t block the event loop.

You may use the rename method supporting the same arguments as Node.js’ built-in method. In this case, the @supercharge/filesystem package just passes the calls through to Node.js’ core module without adding extra handling:

const Path = require('path')  
const Fs = require('@supercharge/filesystem')

const oldPath = Path.join(__dirname, "oldFile.txt")  
const newPath = Path.join(__dirname, "newFile.txt")

await Fs.rename(oldPath, newPath)

Enjoy!

Mentioned Resources

Marcus Pöhls

Marcus is a fullstack JS developer. He’s passionate about the hapi framework for Node.js and loves to build web apps and APIs. Creator of Futureflix and the “learn hapi” learning path.

Explore the Library

Find interesting tutorials and solutions for your problems.

Android

Node.js

Server

Miscellaneous