Find a file or directory by walking up parent directories
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
$ npm install find-up
/
└── Users
└── sindresorhus
├── unicorn.png
└── foo
└── bar
├── baz
└── example.js
example.js
const fs = require('fs');
const path = require('path');
const findUp = require('find-up');
(async () => {
console.log(await findUp('unicorn.png'));
//=> '/Users/sindresorhus/unicorn.png'
console.log(await findUp(['rainbow.png', 'unicorn.png']));
//=> '/Users/sindresorhus/unicorn.png'
const pathExists = filepath => fs.promises.access(filepath).then(_ => true).catch(_ => false);
console.log(await findUp(async (directory) => {
const hasUnicorns = await pathExists(path.join(directory, 'unicorn.png'));
return hasUnicorns && directory;
}});
//=> '/Users/sindresorhus'
})();
Returns a Promise
for either the path or undefined
if it couldn't be found.
Returns a Promise
for either the first path found (by respecting the order) or undefined
if none could be found.
Returns a path or undefined
if it couldn't be found.
Returns the first path found (by respecting the order) or undefined
if none could be found.
Type: string
Name of the file or directory to find.
Type: Function
A function that will be called with each directory until it returns a string
with the path, which stops the search, or the root directory has been reached and nothing was found. Useful if you want to match files with certain patterns, set of permissions, or other advanced use cases.
When using async mode, the matcher
may optionally be an async or promise-returning function that returns the path. When a matcher
function is used, only the cwd
option is supported.
Type: object
Type: string
Default: process.cwd()
Directory to start from.
Type: string
Default: file
Values: file
directory
The type of paths that can match.
Type: boolean
Default: true
Allow symbolic links to match if they point to the chosen path type.
A Symbol that can be returned by a matcher
function to stop the search and cause findUp
to immediately return undefined
. Useful as a performance optimization in case the current working directory is deeply nested in the filesystem.
const path = require('path');
const findUp = require('find-up');
(async () => {
await findUp((directory) => {
return path.basename(directory) === 'work' ? findUp.stop : 'logo.png';
});
})();
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
- find-up-cli - CLI for this module
- pkg-up - Find the closest package.json file
- pkg-dir - Find the root directory of an npm package
- resolve-from - Resolve the path of a module like
require.resolve()
but from a given path
MIT © Sindre Sorhus