find-down

Find a file by walking down parent directories.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
find-down
300.1.45 years ago6 years agoMinified + gzip package size for find-down in KB

Readme

find-down Build status for find-down on Circle CI.
Find a file by walking down parent directories.

Why?

- Find files high up in the filesystem quickly. - Good at finding things that are probably in $HOME. - Is to find-up what indexOf is to lastIndexOf.

Install

npm install find-down --save

Usage

Get it into your program.
const findDown = require('find-down');

Find the topmost file with the given name.
findDown('unicorn.png').then((filepath) => {
    console.log(filepath);  // => '/Users/sholladay/unicorn.png'
});

API

findDown(filename, option)

Returns a Promise for either the filepath or null if it cannot be found.

findDown(filenameA, filenameB, option)

Returns a Promise for either the first filepath found (by respecting the order) or null if none could be found.

filename

Type: string
Filename of the file to find.

option

cwd
Type: string
Default: process.cwd()
Directory to end with.

Contributing

See our contributing guidelines for more details.
  1. Fork it.
  2. Make a feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

MPL-2.0 © Seth Holladay
Go make something, dang it.