Skip to content

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

License

Notifications You must be signed in to change notification settings

buschtoens/p-props

 
 

Repository files navigation

p-props Build Status

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

const pProps = require('p-props');
const got = require('got');

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

	const sites = {
		ava: fetch('avajs.dev'),
		todomvc: fetch('todomvc.com'),
		github: fetch('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

Packages

No packages published

Languages

  • JavaScript 53.2%
  • TypeScript 46.8%