Gecko [ unitednationsplay.com ]

Name	Size	Permission	Date
index.js	1008 B	-rw-r--r--	2016-12-02 13:20
license	1.09 KB	-rw-r--r--	2016-10-25 18:31
package.json	1.7 KB	-rw-r--r--	2021-02-04 21:24
readme.md	1.78 KB	-rw-r--r--	2016-12-02 13:20

Rename

# find-up [![Build Status: Linux and macOS](https://travis-ci.org/sindresorhus/find-up.svg?branch=master)](https://travis-ci.org/sindresorhus/find-up) [![Build Status: Windows](https://ci.appveyor.com/api/projects/status/l0cyjmvh5lq72vq2/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/find-up/branch/master)

> Find a file by walking up parent directories

## Install

```
$ npm install --save find-up
```

## Usage

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

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

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

findUp(['rainbow.png', 'unicorn.png']).then(filepath => {
	console.log(filepath);
	//=> '/Users/sindresorhus/unicorn.png'
});
```

## API

### findUp(filename, [options])

Returns a `Promise` for the filepath or `null`.

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

Returns a `Promise` for the first filepath found (by respecting the order) or `null`.

### 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

##### cwd

Type: `string`<br>
Default: `process.cwd()`

Directory to start from.

## Related

- [find-up-cli](https://github.com/sindresorhus/find-up-cli) - CLI for this module
- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
- [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package

## License