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, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save find-file-up

Usage

1const find = require('find-file-up');

async

1find(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

1// use "~" to search user home
2find('foo.txt', '~/a/b/c')
3  .then(file => console.log(file)) //=> '/Users/jonschlinkert/foo.txt'
4  .catch(console.error);

With async-await

1(async function() {
2  const file = await find('foo.txt', '~/a/b/c');
3  console.log(file);
4  //=> '/Users/jonschlinkert/foo.txt'
5})();

Callback example

1// find `foo.txt` starting at the given directory
2find('foo.txt', 'a/b/c', function(err, file) {
3  if (err) throw err;
4  console.log(file);
5  //=> /Users/jonschlinkert/dev/find-file-up/fixtures/foo.txt
6});

sync

1find.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.

1const file = find.sync('foo.txt', 'a/b/c/');

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• find-pkg: Find the first directory with a package.json, recursing up, starting with the given directory. Similar… more | homepage
• findup-sync: Find the first file matching a given pattern in the current directory or the nearest… more | homepage
• global-modules: The directory used by npm for globally installed npm modules. | homepage

Contributors

Author

Jon Schlinkert

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on March 28, 2018.