README.md

parent-search

Search files and folders in parent directories.

☁️ Installation

# Using npm
npm install --save parent-search

# Using yarn
yarn add parent-search

📋 Example

// Dependencies
var ParentSearch = require("parent-search");

// Search all package.json files starting with this example path
ParentSearch(__dirname + "/path/to/some/directory", "package.json", {
    multiple: true
}, function (err, data) {
    console.log(err || data);
}, function (path, dirname) {
    console.log("Found " + path.p + " in " + path.d);
});

// Search all package.json files starting with this example path
console.log(ParentSearch(__dirname + "/path/to/some/directory", "package.json", { multiple: true }));
console.log(ParentSearch(__dirname + "/path/to/some/directory", "package.json"));
console.log(ParentSearch(__dirname, "index.js", { obj: true }));

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

ParentSearch(path, search, options, callback, progress)

Searches a file/directory in parent directories.

Having the following file structure:

.
├── example
│   └── some
│       └── dir
└── package.json

Supposing you want to find the path to the first package.json file, starting with example/some/dir, just do ParentSearch("path/to/some/dir", "package.json")

Params

• String path: The start directory path.

• String search: The file/directory to search.

• Object options: An object containing the following fields:

• multiple (Boolean): If true, the search will stop only when it reaches the root directory (default: false).

• obj (Boolean): If true, the results will be objects, otherwise they will be strings.

• Function callback: The callback function. If not provided, the sync version will be used instead. This is called with an error in first argument and location object/string of the found file/directory.

• Function progress: The progress function. This is called with an object when the file/directory is found. The object contains:

• d: The directory path of the found path.

• b: The basename.

• p: The absolute path to the file/directory.

• _: The directory of searched path.

Return

• Array|String|Object The location(s) that were found.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• esf-bsc
• blah
• comet-platform
• ssh-remote
• git-stats-importer

📜 License

MIT © Ionică Bizău