Logo for jsDocs.io

p-locate

  • Version 6.0.0
  • Published
  • 7.03 kB
  • 1 dependency
  • MIT license

Install

npm i p-locate
yarn add p-locate
pnpm add p-locate

Overview

Get the first fulfilled promise that satisfies the provided testing function

Index

Functions

Interfaces

Functions

function pLocate

pLocate: <ValueType>(
    input: Iterable<PromiseLike<ValueType> | ValueType>,
    tester: (element: ValueType) => PromiseLike<boolean> | boolean,
    options?: Options
) => Promise<ValueType | undefined>;

  • Get the first fulfilled promise that satisfies the provided testing function.

    Parameter input

    An iterable of promises/values to test.

    Parameter tester

    This function will receive resolved values from input and is expected to return a Promise<boolean> or boolean.

    Returns

    A Promise that is fulfilled when tester resolves to true or the iterable is done, or rejects if any of the promises reject. The fulfilled value is the current iterable value or undefined if tester never resolved to true.

    Example 1

    import {pathExists} from 'path-exists';
    import pLocate from 'p-locate';
    

    const files = [
    	'unicorn.png',
    	'rainbow.png', // Only this one actually exists on disk
    	'pony.png'
    ];
    

    const foundPath = await pLocate(files, file => pathExists(file));
    

    console.log(foundPath);
    //=> 'rainbow'

Interfaces

interface Options

interface Options {}

    property concurrency

    readonly concurrency?: number;

    • The number of concurrently pending promises returned by tester.

      Minimum: 1

      Infinity

    property preserveOrder

    readonly preserveOrder?: boolean;

    • Preserve input order when searching.

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

      true

    Package Files (1)

    Dependencies (1)

    Dev Dependencies (6)

    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/p-locate.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/p-locate)
    • HTML
      <a href="https://www.jsdocs.io/package/p-locate"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>