1 # detect-file [![NPM version](https://img.shields.io/npm/v/detect-file.svg?style=flat)](https://www.npmjs.com/package/detect-file) [![NPM downloads](https://img.shields.io/npm/dm/detect-file.svg?style=flat)](https://npmjs.org/package/detect-file) [![Build Status](https://img.shields.io/travis/doowb/detect-file.svg?style=flat)](https://travis-ci.org/doowb/detect-file)
3 Detect if a filepath exists and resolves the full filepath.
7 Install with [npm](https://www.npmjs.com/):
10 $ npm install --save detect-file
16 var detect = require('detect-file');
21 ### [detect](index.js#L34)
23 Resolve the given `filepath` if it exists.
27 * `filepath` **{String}**: filepath to detect.
28 * `options` **{Object}**: Additional options.
29 * `options.nocase` **{Boolean}**: Set this to `true` force case-insensitive filename checks. This is useful on case sensitive file systems.
30 * `returns` **{String}**: Returns the resolved filepath if it exists, otherwise returns `null`.
35 var res = detect('package.json');
39 var res = detect('fake-file.json');
46 You might also be interested in these projects:
48 [fs-exists-sync](https://www.npmjs.com/package/fs-exists-sync): Drop-in replacement for `fs.existsSync` with zero dependencies. Other libs I found either have crucial differences… [more](https://github.com/jonschlinkert/fs-exists-sync) | [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.")
52 This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/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).
54 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
56 Or visit the [verb-readme-generator](https://github.com/verbose/verb-readme-generator) project to submit bug reports or pull requests for the readme layout template.
60 _(This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
62 Generate readme and API documentation with [verb](https://github.com/verbose/verb):
65 $ npm install -g verb verb-readme-generator && verb
70 Install dev dependencies:
73 $ npm install -d && npm test
80 * [github/doowb](https://github.com/doowb)
81 * [twitter/doowb](http://twitter.com/doowb)
85 Copyright © 2016, [Brian Woodward](https://github.com/doowb).
86 Released under the [MIT license](https://github.com/doowb/detect-file/blob/master/LICENSE).
90 _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on July 06, 2016._