locate-path
- Version 7.2.0
- Published
- 7.25 kB
- 1 dependency
- MIT license
Install
npm i locate-path
yarn add locate-path
pnpm add locate-path
Overview
Get the first path that exists on disk of multiple paths
Index
Functions
function locatePath
locatePath: ( paths: Iterable<string>, options?: AsyncOptions) => Promise<string | undefined>;
Get the first path that exists on disk of multiple paths.
Parameter paths
The paths to check.
Returns
The first path that exists or
undefined
if none exists.Example 1
import {locatePath} from 'locate-path';const files = ['unicorn.png','rainbow.png', // Only this one actually exists on disk'pony.png'];console(await locatePath(files));//=> 'rainbow'
function locatePathSync
locatePathSync: ( paths: Iterable<string>, options?: Options) => string | undefined;
Synchronously get the first path that exists on disk of multiple paths.
Parameter paths
The paths to check.
Returns
The first path that exists or
undefined
if none exists.Example 1
import {locatePathSync} from 'locate-path';const files = ['unicorn.png','rainbow.png', // Only this one actually exists on disk'pony.png'];console(locatePathSync(files));//=> 'rainbow'
Interfaces
interface AsyncOptions
interface AsyncOptions extends Options {}
property concurrency
readonly concurrency?: number;
The number of concurrently pending promises.
Minimum:
1
Infinity
property preserveOrder
readonly preserveOrder?: boolean;
Preserve
paths
order when searching.Disable this to improve performance if you don't care about the order.
true
interface Options
interface Options {}
property allowSymlinks
readonly allowSymlinks?: boolean;
Allow symbolic links to match if they point to the requested path type.
true
property cwd
readonly cwd?: URL | string;
The current working directory.
process.cwd()
property type
readonly type?: 'file' | 'directory';
The type of path to match.
'file'
Package Files (1)
Dependencies (1)
Dev Dependencies (3)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/locate-path
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/locate-path)
- HTML<a href="https://www.jsdocs.io/package/locate-path"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2870 ms. - Missing or incorrect documentation? Open an issue for this package.