Skip to content

TitanInvest/p-props

 
 

Repository files navigation

Titan Fork

The official version of this package is pure ESM, which our build system does not support. See sindresorhus/p-map#44 (comment).

Here we just fork it and to use commonjs.

Ideally we'd convert to ESM, but that's not realistic for us right now, and there are some rough edges we're hoping get sanded off before we do so.

p-props

Like Promise.all() but for Map and Object

Useful when you need to run multiple promises concurrently and keep track of the fulfilled values by name.

Install

npm install p-props

Usage

import pProps from 'p-props';
import got from 'got';

const fetch = async url => {
	const {body} = await got(url);
	return body;
};

const sites = {
	ava: fetch('https://avajs.dev'),
	todomvc: fetch('https://todomvc.com'),
	github: fetch('https://github.com'),
	foo: 'bar'
};

console.log(await pProps(sites));
/*
{
	ava: '<!doctype …',
	todomvc: '<!doctype …',
	github: '<!doctype …',
	foo: 'bar'
}
*/

API

pProps(map, mapper?, options?)

Returns a Promise that is fulfilled when all promises in map and ones returned from mapper are fulfilled, or rejects if any of the promises reject. The fulfilled value is the same as map, but with a fulfilled version of each entry value, or the fulfilled value returned from mapper, if defined.

map

Type: Map | object

Resolves entry values that are promises. Other values are passed through.

mapper(value, key)

Type: Function

Receives the current value and key as parameters. If a value is a Promise, mapper will receive the value this Promise resolves to. Expected to return a Promise or value.

options

Type: object

See the p-map options.

Related

  • p-all - Run promise-returning & async functions concurrently with optional limited concurrency
  • p-map - Map over promises concurrently
  • More…

About

Like `Promise.all()` but for `Map` and `Object`

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 56.9%
  • JavaScript 43.1%