webhook/node_modules/locate-path/readme.md

123 lines
1.8 KiB
Markdown
Raw Normal View History

2022-11-10 14:06:47 +01:00
# locate-path [![Build Status](https://travis-ci.org/sindresorhus/locate-path.svg?branch=master)](https://travis-ci.org/sindresorhus/locate-path)
> Get the first path that exists on disk of multiple paths
2022-11-10 14:06:47 +01:00
## Install
```
2022-11-10 11:43:16 +01:00
$ npm install locate-path
```
2022-11-10 14:06:47 +01:00
## Usage
Here we find the first file that exists on disk, in array order.
```js
const locatePath = require('locate-path');
const files = [
'unicorn.png',
2022-11-10 11:43:16 +01:00
'rainbow.png', // Only this one actually exists on disk
'pony.png'
];
2022-11-10 11:43:16 +01:00
(async () => {
console(await locatePath(files));
//=> 'rainbow'
2022-11-10 11:43:16 +01:00
})();
```
2022-11-10 14:06:47 +01:00
## API
2022-11-10 14:06:47 +01:00
### locatePath(paths, [options])
2022-11-10 11:43:16 +01:00
Returns a `Promise<string>` for the first path that exists or `undefined` if none exists.
2022-11-10 11:43:16 +01:00
#### paths
Type: `Iterable<string>`
Paths to check.
#### options
2022-11-10 14:06:47 +01:00
Type: `Object`
##### concurrency
2022-11-10 14:06:47 +01:00
Type: `number`<br>
Default: `Infinity`<br>
Minimum: `1`
Number of concurrently pending promises.
##### preserveOrder
2022-11-10 14:06:47 +01:00
Type: `boolean`<br>
Default: `true`
2022-11-10 11:43:16 +01:00
Preserve `paths` order when searching.
Disable this to improve performance if you don't care about the order.
##### cwd
2022-11-10 14:06:47 +01:00
Type: `string`<br>
Default: `process.cwd()`
Current working directory.
2022-11-10 11:43:16 +01:00
##### type
2022-11-10 14:06:47 +01:00
Type: `string`<br>
Default: `file`<br>
Values: `file` `directory`
2022-11-10 11:43:16 +01:00
The type of paths that can match.
##### allowSymlinks
2022-11-10 14:06:47 +01:00
Type: `boolean`<br>
2022-11-10 11:43:16 +01:00
Default: `true`
Allow symbolic links to match if they point to the chosen path type.
2022-11-10 14:06:47 +01:00
### locatePath.sync(paths, [options])
Returns the first path that exists or `undefined` if none exists.
2022-11-10 11:43:16 +01:00
#### paths
Type: `Iterable<string>`
Paths to check.
#### options
2022-11-10 14:06:47 +01:00
Type: `Object`
##### cwd
Same as above.
2022-11-10 11:43:16 +01:00
##### type
2022-11-10 11:43:16 +01:00
Same as above.
2022-11-10 11:43:16 +01:00
##### allowSymlinks
2022-11-10 11:43:16 +01:00
Same as above.
2022-11-10 14:06:47 +01:00
2022-11-10 11:43:16 +01:00
## Related
2022-11-10 11:43:16 +01:00
- [path-exists](https://github.com/sindresorhus/path-exists) - Check if a path exists
2022-11-10 14:06:47 +01:00
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)