locate-path
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 107,883,752
- increased by8.84%
Weekly downloads
Readme
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.
import {locatePath} from 'locate-path';
const files = [
'unicorn.png',
'rainbow.png', // Only this one actually exists on disk
'pony.png'
];
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>
The paths to check.
options
Type: object
concurrency
Type: number
Default: Infinity
Minimum: 1
The 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: URL | string
Default: process.cwd()
The 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.
locatePathSync(paths, options?)
Returns the first path that exists or undefined if none exists.
paths
Type: Iterable<string>
The 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.
FAQs
Get the first path that exists on disk of multiple paths
The npm package locate-path receives a total of 87,648,489 weekly downloads. As such, locate-path popularity was classified as popular.
We found that locate-path demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.