Logo for jsDocs.io

locate-path

  • Version 8.0.0
  • Published
  • 7.17 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

Type Aliases

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.log(await locatePath(files));
    //=> 'rainbow.png'

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.log(locatePathSync(files));
    //=> 'rainbow.png'

Type Aliases

type AsyncOptions

type AsyncOptions = {
    /**
	The number of concurrently pending promises.


	Minimum: `1`


	@default Infinity
	*/
    readonly concurrency?: number;


    /**
	Preserve `paths` order when searching.


	Disable this to improve performance if you don't care about the order.


	@default true
	*/
    readonly preserveOrder?: boolean;
} & Options;

    type Options

    type Options = {
        /**
    	The current working directory.
    

    	@default process.cwd()
    	*/
        readonly cwd?: URL | string;
    

        /**
    	The type of path to match.
    

    	- `'file'` - Only match files
    	- `'directory'` - Only match directories
    	- `'both'` - Match both files and directories
    

    	@default 'file'
    	*/
        readonly type?: 'file' | 'directory' | 'both';
    

        /**
    	Allow symbolic links to match if they point to the requested path type.
    

    	@default true
    	*/
        readonly allowSymlinks?: boolean;
    };

      Package Files (1)

      Dependencies (1)

      Dev Dependencies (3)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto 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>