Get the first path that exists on disk of multiple paths
npm install locate-path
Here we find the first file that exists on disk, in array order.
import {locatePath} from 'locate-path';
const files = [
'unicorn.png',
'rainbow.png', // Only this one actually exists on disk
'pony.png'
];
console.log(await locatePath(files));
//=> 'rainbow.png'
Returns a Promise<string>
for the first path that exists or undefined
if none exists.
Type: Iterable<string>
The paths to check.
Type: object
Type: number
Default: Infinity
Minimum: 1
The number of concurrently pending promises.
Type: boolean
Default: true
Preserve paths
order when searching.
Disable this to improve performance if you don't care about the order.
Type: URL | string
Default: process.cwd()
The current working directory.
Type: string
Default: 'file'
Values: 'file' | 'directory' | 'both'
The type of path to match.
'file'
- Only match files'directory'
- Only match directories'both'
- Match both files and directories
Type: boolean
Default: true
Allow symbolic links to match if they point to the chosen path type.
Returns the first path that exists or undefined
if none exists.
Type: Iterable<string>
The paths to check.
Type: object
Same as above.
Same as above.
Same as above.
- path-exists - Check if a path exists