locate-path ![Build Status](https://camo.githubusercontent.com/224f21024c6b27d0aa6d5d32879c03fe039e56b368c37be4472fab1a0d1161ad/68747470733a2f2f7472617669732d63692e636f6d2f73696e647265736f726875732f6c6f636174652d706174682e7376673f6272616e63683d6d6173746572)
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(paths, options?)
Returns a Promise<string>
for the first path that exists or undefined
if none exists.
paths
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 paths
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.
type
Type: string
Default: 'file'
Values: 'file' | 'directory'
The type of paths that can match.
allowSymlinks
Type: boolean
Default: true
Allow symbolic links to match if they point to the chosen path type.
locatePath.sync(paths, options?)
Returns the first path that exists or undefined
if none exists.
paths
Type: Iterable<string>
Paths to check.
options
Type: object
cwd
Same as above.
type
Same as above.
allowSymlinks
Same as above.
Related
- path-exists - Check if a path exists
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.