FM / locate-path

/var/www/greso.tech/server/nsm/node_modules/locate-path/

/var/www/greso.tech/server/nsm/node_modules/locate-path

Name	Size	Mode	Actions
index.d.ts	1577	0644	edit dl rm
index.js	1336	0644	edit dl rm
license	1109	0644	edit dl rm
package.json	720	0644	edit dl rm
readme.md	1842	0644	edit dl rm

Edit: /var/www/greso.tech/server/nsm/node_modules/locate-path/readme.md (1842B)

# 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

## Install

```
$ npm install locate-path
```

## Usage

Here we find the first file that exists on disk, in array order.

```js
const locatePath = require('locate-path');

const files = [
	'unicorn.png',
	'rainbow.png', // Only this one actually exists on disk
	'pony.png'
];

(async () => {
	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>`

Paths to check.

#### options

Type: `Object`

##### concurrency

Type: `number` 
Default: `Infinity` 
Minimum: `1`

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: `string` 
Default: `process.cwd()`

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.

### locatePath.sync(paths, [options])

Returns the first path that exists or `undefined` if none exists.

#### paths

Type: `Iterable<string>`

Paths to check.

#### options

Type: `Object`

##### cwd

Same as above.

##### type

Same as above.

##### allowSymlinks

Same as above.

## Related

- [path-exists](https://github.com/sindresorhus/path-exists) - Check if a path exists

## License

cmd: