Node.js — How to Touch a File

UNIX-based operating systems have a touch utility available on the command line. touch updates the access and modification times of a given file to the current time. A nice benefit: touch also creates the given file if it doesn’t exist.

This tutorial shows you how to implement a touch-like function using Node.js.

Node.js Series Overview

Implement a Touch Method in Node.js

This tutorial uses the fs-extra package providing extra file system methods. One of the extra methods is ensureFile(path). This method ensures that a file exists at path or creates an empty file at path.

The second part for the touch method is the timestamp update. Node.js comes with a utimes method in the fs core module. The utimes methods updates a file’s last accessed or modified timestamps. The utimes method is also available through fs-extra.

You can combine the ensureFile method with utimes to create a method behaving like touch:

const Fs = require('fs-extra')

/**
 * Updates the access and modification times of the given `file` current
 * time. This method creates the `file` if it doesn’t exist.
 *
 * @param {String} file
 */
async touch (file: string) {  
  await Fs.ensureFile(file)

  const now = new Date()
  await Fs.utimes(file, now, now)
}

You can then go ahead and use the implemented touch method to update the timestamps for a specific file. Determine the lastAccessed and lastModified dates of the file using the related methods from Node.js’ fs module:

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

await touch('./file.txt')

await Fs.lastAccessed('./file.txt')  
// 2021-02-14T12:27:12.877Z
await Fs.lastModified('./file.txt')  
// 2021-02-14T12:27:12.877Z

await touch('./file.txt')

await Fs.lastAccessed('./file.txt')  
// 2021-02-14T12:27:26.191Z
await Fs.lastModified('./file.txt')  
// 2021-02-14T12:27:12.877Z

Use the @supercharge/filesystem Package

I’m the maintainer of the @supercharge/filesystem package providing convenient file system utilities.

One of the available methods is touch: combining the functionality of creating a file if it doesn’t exists and then updating the access and modification times to the current time:

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

await Fs.touch('./file.txt')

await Fs.lastAccessed('./file.txt')  
// 2021-02-14T12:28:10.877Z
await Fs.lastModified('./file.txt')  
// 2021-02-14T12:28:10.877Z

await Fs.touch('./names.txt')

await Fs.lastAccessed('./file.txt')  
// 2021-02-14T12:28:39.191Z
await Fs.lastModified('./file.txt')  
// 2021-02-14T12:28:39.191Z

Enjoy!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.