Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

p-locate

Package Overview
Dependencies
1
Maintainers
1
Versions
7
Issues
File Explorer

Advanced tools

p-locate

Get the first fulfilled promise that satisfies the provided testing function

    6.0.0latest

Version published
Maintainers
1
Yearly downloads
3,568,750,427
increased by63.46%

Weekly downloads

Changelog

Source

Breaking

  • Require Node.js 12.20 05f1972
  • This package is now pure ESM. Please read this.

https://github.com/sindresorhus/p-locate/compare/v5.0.0...v6.0.0

Readme

Source

p-locate

Get the first fulfilled promise that satisfies the provided testing function

Think of it like an async version of Array#find.

Install

$ npm install p-locate

Usage

Here we find the first file that exists on disk, in array order.

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'

The above is just an example. Use locate-path if you need this.

API

pLocate(input, tester, options?)

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.

input

Type: Iterable<Promise | unknown>

An iterable of promises/values to test.

tester(element)

Type: Function

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

options

Type: object

concurrency

Type: number
Default: Infinity
Minimum: 1

The number of concurrently pending promises returned by tester.

preserveOrder

Type: boolean
Default: true

Preserve input order when searching.

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

  • p-map - Map over promises concurrently
  • p-filter - Filter promises concurrently
  • p-any - Wait for any promise to be fulfilled
  • More…

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.

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc