file-exists
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/file-exists package

5.0.1 • Public • Published

file-exists

Check if filepath exists and is a file. Returns false for directories.

(Requires node >=6.0.0)

Install

npm install file-exists --save

Usage

const fileExists = require('file-exists');
 
fileExists('/index.html', (err, exists) => console.log(exists)) // OUTPUTS: true or false
 
fileExists('/index.html').then(exists => {
  console.log(exists) // OUTPUTS: true or false
})
 
console.log(fileExists.sync('/index.html')) // OUTPUTS: true or false

Options

fileExists(filepath[, options, callback])

  • filepath - the path to the file to check if it exists
  • options - an object of options
    • root - the root directory to look in (or cwd)
  • callback(err, exists) - gets called when checking is done

fileExists.sync(filepath[, options])

  • filepath - the path to the file to check if it exists
  • options - an object of options
    • root - the root directory to look in (or cwd)

Run Tests

npm install
npm test

Dependencies (0)

    Dev Dependencies (5)

    Package Sidebar

    Install

    npm i file-exists

    Weekly Downloads

    50,421

    Version

    5.0.1

    License

    MIT

    Last publish

    Collaborators

    • scottcorgan