JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2158642
  • Score
    100M100P100Q195488F
  • License MIT

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.

Package Exports

  • find-file-up

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (find-file-up) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

find-file-up NPM version NPM monthly downloads NPM total downloads Linux Build Status

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 ❤️ and support.

Install

Install with npm:

$ npm install --save find-file-up

Usage

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

async

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

// 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

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

Callback example

// 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

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

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:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

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

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

Commits Contributor
26 jonschlinkert
1 pointnet

Author

Jon Schlinkert

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.