athea

Repositories Projects Packages

locate-path (3.0.0)

Published 2026-02-24 14:00:54 +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 locate-path@3.0.0

or add it to the package.json file:

"locate-path": "3.0.0"

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

About this package

locate-path

Get the first path that exists on disk of multiple paths

Install

$ npm install locate-path

Usage

Here we find the first file that exists on disk, in array order.

const locatePath = require('locate-path');

const files = [
	'unicorn.png',
	'rainbow.png', // Only this one actually exists on disk
	'pony.png'
];

(async () => {
	console(await locatePath(files));
	//=> 'rainbow'
})();

API

locatePath(input, [options])

Returns a Promise for the first path that exists or undefined if none exists.

input

Type: Iterable<string>

Paths to check.

options

Type: Object

concurrency

Type: number
Default: Infinity
Minimum: 1

Number of concurrently pending promises.

preserveOrder

Type: boolean
Default: true

Preserve input order when searching.

Disable this to improve performance if you don't care about the order.

cwd

Type: string
Default: process.cwd()

Current working directory.

locatePath.sync(input, [options])

Returns the first path that exists or undefined if none exists.

input

Type: Iterable<string>

Paths to check.

options

Type: Object

cwd

Same as above.

Related

• path-exists - Check if a path exists

License

MIT © Sindre Sorhus

Dependencies

Dependencies

ID	Version
p-locate	^3.0.0
path-exists	^3.0.0

Development Dependencies

ID	Version
ava	*
xo	*

Keywords

locate path paths file files exists find finder search searcher array iterable iterator

Details

npm

2026-02-24 14:00:54 +00:00

0

Sindre Sorhus

Project Site

MIT

1.9 KiB

Assets (1)

locate-path-3.0.0.tgz 1.9 KiB

Versions (3) View all

6.0.0 2026-02-24

3.0.0 2026-02-24

5.0.0 2026-02-24