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