Socket
Socket
Sign inDemoInstall

path-exists

Package Overview
Dependencies
0
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    path-exists

Check if a path exists


Version published
Weekly downloads
83M
decreased by-1.92%
Maintainers
1
Install size
5.05 kB
Created
Weekly downloads
 

Package description

What is path-exists?

The path-exists npm package is used to check if a file or directory exists on the file system without using fs.existsSync. It is built on top of Node.js's fs.promises API and provides a simple promise-based interface.

What are path-exists's main functionalities?

Check if a path exists

This feature allows you to check if a file or directory exists asynchronously by returning a promise that resolves to either true or false.

const pathExists = require('path-exists');

(async () => {
  const exists = await pathExists('/path/to/file');
  console.log(exists);
  //=> true or false
})();

Check if a path exists synchronously

This feature provides a synchronous way to check if a file or directory exists, returning a boolean value immediately.

const pathExists = require('path-exists');

const exists = pathExists.sync('/path/to/file');
console.log(exists);
//=> true or false

Other packages similar to path-exists

Readme

Source

path-exists

Check if a path exists

NOTE: fs.existsSync has been un-deprecated in Node.js since 6.8.0. If you only need to check synchronously, this module is not needed.

Never use this before handling a file though:

In particular, checking if a file exists before opening it is an anti-pattern that leaves you vulnerable to race conditions: another process may remove the file between the calls to fs.exists() and fs.open(). Just open the file and handle the error when it's not there.

Install

$ npm install path-exists

Usage

// foo.js
import {pathExists} from 'path-exists';

console.log(await pathExists('foo.js'));
//=> true

API

pathExists(path)

Returns a Promise<boolean> of whether the path exists.

pathExistsSync(path)

Returns a boolean of whether the path exists.

  • path-exists-cli - CLI for this module
  • path-type - Check if a path exists and whether it's a file, directory, or symlink

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Keywords

FAQs

Last updated on 12 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc