locate-path
Get the first path that exists on disk of multiple paths
Last updated a year ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install locate-path 
SYNC missed versions from official npm registry.

locate-path Build Status

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.

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

License

MIT © Sindre Sorhus

Current Tags

  • 5.0.0                                ...           latest (a year ago)

6 Versions

  • 5.0.0                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.0.0                                ...           2 years ago
  • 2.0.0                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 44,016
This Week 136,572
This Month 998,011
Last Day 92,556
Last Week 534,089
Last Month 2,156,675
Dependencies (1)
Dev Dependencies (3)
Dependents (98)

Copyright 2014 - 2017 © taobao.org |