JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 176167507
  • Score
    100M100P100Q242121F
  • License MIT

Get the first path that exists on disk of multiple paths

Package Exports

  • locate-path

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (locate-path) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.

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.

License

MIT © Sindre Sorhus