webhook-action/node_modules/locate-path
Joel Male 1ada95e04a
v2.0.0 (#12)
- Convert project to Javascript/Typescript
- Allow custom headers to be passed in (optional)
- Allow body to be optional
2020-08-26 10:52:47 +10:00
..
index.js v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
license v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
package.json v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
readme.md v2.0.0 (#12) 2020-08-26 10:52:47 +10:00

locate-path Build Status

Get the first path that exists on disk of multiple paths

Install

$ npm install --save 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'
];

locatePath(files).then(foundPath => {
	console.log(foundPath);
	//=> '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.

License

MIT © Sindre Sorhus