GT2/GT2-iOS/node_modules/locate-path
Ren Ren Juan 30eef7d036 correct tree err 2018-02-12 17:26:06 +00:00
..
index.js correct tree err 2018-02-12 17:26:06 +00:00
license correct tree err 2018-02-12 17:26:06 +00:00
package.json correct tree err 2018-02-12 17:26:06 +00:00
readme.md correct tree err 2018-02-12 17:26:06 +00:00

readme.md

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