athea

Repositories Projects Packages

find-up (3.0.0)

Published 2026-02-24 13:56:50 +00:00 by atheaadmin

Installation

Setup this registry in your project .npmrc file:

registry=

To install the package using npm, run the following command:

npm install find-up@3.0.0

or add it to the package.json file:

"find-up": "3.0.0"

For more information on the npm registry, see the documentation.

About this package

find-up

Find a file or directory by walking up parent directories

Install

$ npm install find-up

Usage

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

example.js

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

API

findUp(filename, [options])

Returns a Promise for either the filepath or null if it couldn't be found.

findUp([filenameA, filenameB], [options])

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

findUp.sync(filename, [options])

Returns a filepath or null.

findUp.sync([filenameA, filenameB], [options])

Returns the first filepath found (by respecting the order) or null.

filename

Type: string

Filename of the file to find.

options

Type: Object

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
• resolve-from - Resolve the path of a module like require.resolve() but from a given path

License

MIT © Sindre Sorhus

Dependencies

Dependencies

ID	Version
locate-path	^3.0.0

Development Dependencies

ID	Version
ava	*
tempy	^0.2.1
xo	*

Keywords

find up find-up findup look-up look file search match package resolve parent parents folder directory dir walk walking path

Details

npm

2026-02-24 13:56:50 +00:00

0

Sindre Sorhus

Project Site

MIT

2.2 KiB

Assets (1)

find-up-3.0.0.tgz 2.2 KiB

Versions (3) View all

5.0.0 2026-02-24

3.0.0 2026-02-24

4.1.0 2026-02-24