# find-file-up
> Find a file fast, by starting at the given cwd and recursing up one directory until the file is found or we run out of directories.
Latest version **2.0.1** (published 2018-03-28) · MIT license · 0 weekly downloads
> **Better alternative:** See documentation for alternatives (https://github.com/AikidoSec/module-replacements/blob/main/docs/find-file-up)
## Install
```sh
npm install find-file-up
pnpm add find-file-up
yarn add find-file-up
bun add find-file-up
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.1 |
| Published | 2018-03-28 |
| First published | 2015-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | file, find, up |
## Links
- npm: https://www.npmjs.com/package/find-file-up
- Repository: https://github.com/jonschlinkert/find-file-up
- Issues: https://github.com/jonschlinkert/find-file-up/issues
- npm.io page: https://npm.io/package/find-file-up
## Dependencies (1)
- [resolve-dir](https://npm.io/package/resolve-dir.md) ^1.0.1
## Alternatives
- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads
## Recent versions
- 2.0.1 (latest) — 2018-03-28
- 2.0.0 — 2018-03-28
- 1.0.2 — 2017-05-20
- 1.0.1 — 2017-05-20
- 0.1.3 — 2016-07-18
- 0.1.2 — 2016-06-05
- 0.1.1 — 2015-12-20
- 0.1.0 — 2015-11-28
## README
# find-file-up [](https://www.npmjs.com/package/find-file-up) [](https://npmjs.org/package/find-file-up) [](https://npmjs.org/package/find-file-up) [](https://travis-ci.org/jonschlinkert/find-file-up)
> Find a file fast, by starting at the given cwd and recursing up one directory until the file is found or we run out of directories.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save find-file-up
```
## Usage
```js
const find = require('find-file-up');
```
## async
```js
find(filename, cwd, limit, callback);
```
**Example**
* `filename` **String** - (required) the name of the file to find.
* `cwd` **String** - (optional) the starting directory. This value can be prefixed with `~` to search from the user home directory.
* `limit` **Number** - (optional) limit the number of directories to recurse.
* `callback` **Functional** - (optional) A promise is returned when no callback is passed.
**Promise example**
```js
// use "~" to search user home
find('foo.txt', '~/a/b/c')
.then(file => console.log(file)) //=> '/Users/jonschlinkert/foo.txt'
.catch(console.error);
```
**With async-await**
```js
(async function() {
const file = await find('foo.txt', '~/a/b/c');
console.log(file);
//=> '/Users/jonschlinkert/foo.txt'
})();
```
**Callback example**
```js
// find `foo.txt` starting at the given directory
find('foo.txt', 'a/b/c', function(err, file) {
if (err) throw err;
console.log(file);
//=> /Users/jonschlinkert/dev/find-file-up/fixtures/foo.txt
});
```
### sync
```js
find.sync(filename, cwd, limit);
```
**Example**
* `filename` **String** - (required) the name of the file to find.
* `cwd` **String** - (optional) the starting directory.
* `limit` **Number** - (optional) limit the number of directories to recurse.
```js
const file = find.sync('foo.txt', 'a/b/c/');
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [find-pkg](https://www.npmjs.com/package/find-pkg): Find the first directory with a package.json, recursing up, starting with the given directory. Similar… [more](https://github.com/jonschlinkert/find-pkg) | [homepage](https://github.com/jonschlinkert/find-pkg "Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.")
* [findup-sync](https://www.npmjs.com/package/findup-sync): Find the first file matching a given pattern in the current directory or the nearest… [more](https://github.com/js-cli/node-findup-sync#readme) | [homepage](https://github.com/js-cli/node-findup-sync#readme "Find the first file matching a given pattern in the current directory or the nearest ancestor directory.")
* [global-modules](https://www.npmjs.com/package/global-modules): The directory used by npm for globally installed npm modules. | [homepage](https://github.com/jonschlinkert/global-modules "The directory used by npm for globally installed npm modules.")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 26 | [jonschlinkert](https://github.com/jonschlinkert) |
| 1 | [pointnet](https://github.com/pointnet) |
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 28, 2018._
---
_Source: https://npm.io/package/find-file-up · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._