find-up

What is find-up?

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.

What are find-up's main functionalities?

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'
})();

Other packages similar to find-up

locate-path

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.

pkg-up

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

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.

README

find-up

Find a file by walking up parent directories

Install

$ npm install --save find-up

Usage

/
└── Users
    └── sindresorhus
        ├── unicorn.png
        └── foo
            └── bar
                ├── baz
                └── example.js

// example.js
const findUp = require('find-up');

findUp('unicorn.png').then(filepath => {
	console.log(filepath);
	//=> '/Users/sindresorhus/unicorn.png'
});

API

findUp(filename, [options])

Returns a promise for the filepath or null.

findUp.sync(filename, [options])

Returns a filepath or null.

filename

Type: string

Filename of the file to find.

options

cwd

Type: string
Default: process.cwd()

Directory to start from.

Related

• 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

License

MIT © Sindre Sorhus