detect-file   

Detect if a filepath exists and resolves the full filepath.

Install

Install with npm:

sh
$ npm install --save detect-file

Usage

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

API

[detect](index.js#L34)

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

js
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](https://github.com/jonschlinkert/fs-exists-sync "Drop-in replacement for fs.existsSync with zero dependencies. Other libs I found either have crucial differences from fs.existsSync, or unnecessary dependencies. See README.md for more info.")

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](.verb.md). See [Building Docs](#building-docs).

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

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](.verb.md).)_

Generate readme and API documentation with verb:

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

Running tests

Install dev dependencies:

sh
$ 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._