Check if a file or directory exists synchronously in Node.js

David Y.

The Problem

How can I check synchronously if a file or directory exists in Node.js?

The Solution

The function fs.existsSync() can be used to synchronously check if a file or directory exists. The asynchronous version of this function, fs.exists(), is deprecated, but fs.existsSync() will still work.

Example usage:

const fs = require("fs"); if (fs.existsSync("/tmp/myfile")) { console.log("/tmp/myfile exists!"); } else { console.log("/tmp/myfile does not exist!"); }

Note that this function will return True if myfile is a file or a directory, as long as it exists. We can use fs.lstatSync() on the path to retrieve an fs.Stats object containing information about the path. This object has an isDirectory() method we can use:

const fs = require("fs"); if (fs.existsSync("/tmp/myfile")) { console.log("/tmp/myfile exists!"); if (fs.lstatSync("/tmp/myfile").isDirectory()) { console.log("/tmp/myfile is a directory!"); } else { console.log("/tmp/myfile is a file!"); } } else { console.log("/tmp/myfile does not exist!"); }

Get Started With Sentry

Get actionable, code-level insights to resolve Node performance bottlenecks and errors.

  1. Create a free Sentry account

  2. Create a Node project and note your DSN

  3. Install the Sentry Node SDK

npm install @sentry/node
  1. Configure your DSN
const Sentry = require('@sentry/node'); Sentry.init({ dsn: 'https://<key>@sentry.io/<project>' });

Loved by over 4 million developers and more than 90,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

Share on Twitter
Bookmark this page
Ask a questionJoin the discussion

Related Answers

A better experience for your users. An easier life for your developers.

    TwitterGitHubDribbbleLinkedinDiscord
© 2024 • Sentry is a registered Trademark
of Functional Software, Inc.