detect-file

What is detect-file?

The detect-file npm package is designed to help developers determine if a file exists in a given path. It provides a simple and efficient way to check for the presence of files without having to manually handle file system operations. This can be particularly useful in build scripts, file validation processes, or any scenario where ensuring the existence of a file is necessary.

What are detect-file's main functionalities?

Check if a file exists

This feature allows you to check if a specific file exists at a given path. The function returns a boolean indicating the presence of the file.

const detectFile = require('detect-file');

const filePath = 'path/to/your/file.txt';
const exists = detectFile(filePath);

if (exists) {
  console.log('File exists.');
} else {
  console.log('File does not exist.');
}

Other packages similar to detect-file

fs-extra

fs-extra is a package that builds on the native fs module, providing additional methods to interact with the file system. It includes a method called 'pathExists' which can be used to check if a file exists, similar to detect-file. However, fs-extra offers a broader range of file system operations, making it more versatile.

file-exists

file-exists is another npm package that offers functionality similar to detect-file, specifically focused on checking the existence of files. While both packages serve a similar purpose, file-exists provides both synchronous and asynchronous APIs, giving developers more flexibility in how they perform the check.

README

detect-file

Detect if a filepath exists and resolves the full filepath.

Install

Install with npm:

$ npm install --save detect-file

Usage

var detect = require('detect-file');

API

detect

Resolve the given filepath if it exists.

Params

• filepath {String}: filepath to detect.
• options {Object}: Additional options.
• options.nocase {Boolean}: Set this to true force case-insensitive filename checks. This is useful on case sensitive file systems.
• returns {String}: Returns the resolved filepath if it exists, otherwise returns null.

Example

var res = detect('package.json');
console.log(res);
//=> "package.json"

var res = detect('fake-file.json');
console.log(res)
//=> null

Related projects

You might also be interested in these projects:

fs-exists-sync: Drop-in replacement for fs.existsSync with zero dependencies. Other libs I found either have crucial differences… more | homepage

Contributing

This document was generated by verb-readme-generator (a verb generator), please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.

Building docs

(This document was generated by verb-readme-generator (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on July 06, 2016.