Node.js — Retrieve the OS Directory for Temporary Files

During development, you may need to store temporary data on the local file system. This temporary data could be anything short-lived, like the content you read from another source. You may want to transfer this temporary content to your application and have to find storage that you don’t need to clean up yourself.

All operating systems provide a temporary directory. The OS cleans up files in this temporary directory automatically after a given period of time. If you’re storing non-sensitive data, this might be the right place for you to store temporary content and let the OS clean up after you.

This tutorial shows you how to retrieve the path of your operating system’s temporary directory.

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or 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
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js
  27. Check if a String is Empty in JavaScript or Node.js
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js
  29. Left-Trim Characters Off a String in JavaScript or Node.js
  30. Right-Trim Characters Off a String in JavaScript or Node.js
  31. Lowercase the First Character of a String in JavaScript or Node.js
  32. Uppercase the First Character of a String in JavaScript or Node.js
  33. Prepend Characters or Words to a String in JavaScript or Node.js
  34. Check if a String is a Number
  35. Convert a String to Buffer
  36. Prevent Line Breaks in String Template Literals
  37. How to Implement a Custom `toString` Method
  38. What Is `Symbol.toStringTag` and How to Use It (Coming soon)

Get the Temporary Directory of Your Operating System

Node.js ships with a built-in os module that provides useful methods to interact with the operating system. One of the methods is os.tmpdir() returning the operating system’s path to the default directory for temporary files.

Here’s an example of how to retrieve the directory path for temporary files on macOS:

import os from 'os'

os.tmpdir()  
// /var/folders/71/lxgy9vm54fb7tjcwr55mwccr0000gn/T

Generally, you can assume the temporary directory exists on your file system. When interacting with directories or files inside the directory, you still need to (recursively) create the file structure or check for existence when reading files. Otherwise, Node.js throws the related exceptions when trying to access files that don’t exist.

Use the @supercharge/fs Package

I’m the maintainer of the @supercharge/fs package providing convenient file system utilities. The @supercharge/fs package comes with a handy Fs.tempDir() method creating a folder inside the operating system’s temporary directory.

import Fs from '@supercharge/fs'

await Fs.tempDir()  
// /var/folders/71/lxgy9vm54fb7tjcwr55mwccr0000gn/T/1b114e534d3ff95ea5951bb3db5c1cb3

Changed Handling Coming to @supercharge/fs in 4.0.0

The @supercharge/fs package is in development for a new major version 4.0.0. Starting from 4.0.0, the Fs.tempDir() method works the same way as Node.js and returns the path to the OS’s temporary directory. If you want to create a dedicated, temporary folder use the newly added Fs.createTempDir() method:

// this code will only work in @supercharge/fs version 4.0.0
import Fs from '@supercharge/fs'

Fs.tempDir()  
// /var/folders/71/lxgy9vm54fb7tjcwr55mwccr0000gn/T

// creates the directory on the file system and returns the created path
await Fs.createTempDir()  
// /var/folders/71/lxgy9vm54fb7tjcwr55mwccr0000gn/T/1b114e534d3ff95ea5951bb3db5c1cb3

Enjoy retrieving temporary file paths in Node.js!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.