The find-up npm package is a utility that allows you to find and read files or directories by traversing up the file system. It's useful for finding configuration files and other resources that may be located in a parent directory relative to the current working directory.
Find a file by name
This feature allows you to find a file by its name, starting from the current directory and searching upwards through the parent directories.
const findUp = require('find-up');
(async () => {
const filePath = await findUp('unicorn.png');
console.log(filePath);
//=> '/Users/sindresorhus/unicorn.png'
})();Find a file using a matcher function
This feature allows you to use a custom matcher function to find a file. The function receives the current directory and returns the path to stop at or `undefined` to continue searching.
const findUp = require('find-up');
(async () => {
const filePath = await findUp(directory => directory === '/Users/sindresorhus' ? 'unicorn.png' : undefined);
console.log(filePath);
//=> '/Users/sindresorhus/unicorn.png'
})();Find a file with a specific name in an array of names
This feature allows you to pass an array of file names to `findUp`, and it will return the first file found with one of those names.
const findUp = require('find-up');
(async () => {
const filePath = await findUp(['rainbow.png', 'unicorn.png']);
console.log(filePath);
//=> '/Users/sindresorhus/unicorn.png'
})();The locate-path package is similar to find-up as it also searches for files or directories by traversing up the directory tree. However, locate-path does not provide the convenience methods for matching files that find-up does.
The pkg-up package is designed specifically to find the closest package.json file in the directory tree. It is a more specialized tool compared to find-up, which can search for any file or directory.
findup-sync is similar to find-up but uses glob patterns for searching and is based on the micromatch library. It provides a synchronous API, unlike find-up which is promise-based and supports async/await.
Find a file or directory by walking up parent directories
$ 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;
}}, {type: '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.
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.
require.resolve() but from a given pathMIT © Sindre Sorhus
FAQs
Find a file or directory by walking up parent directories
The npm package find-up receives a total of 103,610,759 weekly downloads. As such, find-up popularity was classified as popular.
We found that find-up demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.