locate-path

WebJar for locate-path

License	MIT
GroupId	org.webjars.npm
ArtifactId	locate-path
Last Version	6.0.0
Release Date	Nov 23, 2020
Type	jar
Description	locate-path WebJar for locate-path
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/locate-path

Download locate-path

Filename	Size
locate-path-6.0.0.pom
locate-path-6.0.0.jar	5 KB
locate-path-6.0.0-sources.jar	22 bytes
locate-path-6.0.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/locate-path/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>locate-path</artifactId>
    <version>6.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/locate-path/
implementation 'org.webjars.npm:locate-path:6.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/locate-path/
implementation ("org.webjars.npm:locate-path:6.0.0")

Apache Buildr

'org.webjars.npm:locate-path:jar:6.0.0'

Apache Ivy

<dependency org="org.webjars.npm" name="locate-path" rev="6.0.0">
  <artifact name="locate-path" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='locate-path', version='6.0.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "locate-path" % "6.0.0"

Leiningen

[org.webjars.npm/locate-path "6.0.0"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : p-locate	jar	[5.0.0,6)

Project Modules

There are no modules declared in this project.

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.

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 - Check if a path exists

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

Versions

Version
6.0.0 Nov 23, 2020
5.0.0 Jan 8, 2020
3.0.0 Jul 4, 2018
2.0.0 Aug 25, 2017
1.1.0 Aug 25, 2017