bevrynative-promise-pool
Create a pool of a specified concurrency that accepts functions that return promises
Usage
To use, just make a promise pool with the specified concurrency, then wrap the method in a pool.open(() => /* the code that you want pooled */). The callback is necessary, as otherwise the code that you want pooled will execute before it is pooled. By pooling it, it executes once the pool entry is called.
import PromisePool from 'native-promise-pool'
const pool = new PromisePool(2) // 5 tasks at once
await Promise.all([
pool.open(() => /* the thing that takes a while */)
pool.open(() => /* the thing that takes a while */)
pool.open(() => /* the thing that takes a while, will run after the first two have completed */)
])
Table Example
Simple Example
Await Example
Finally
This package depends on Promise.prototype.finally existing, which it does on Node v10 and above.
On older environments, you must use a shim, like so:
require('promise.prototype.finally').shim()
const pool = require('native-promise-pool').create({ concurrency: 2 })
Install
npm
- Install:
npm install --save native-promise-pool - Import:
import pkg from ('native-promise-pool') - Require:
const pkg = require('native-promise-pool').default
Deno
import pkg from 'https://unpkg.com/native-promise-pool@^3.28.0/edition-deno/index.ts'
Skypack
<script type="module">
import pkg from '//cdn.skypack.dev/native-promise-pool@^3.28.0'
</script>
unpkg
<script type="module">
import pkg from '//unpkg.com/native-promise-pool@^3.28.0'
</script>
jspm
<script type="module">
import pkg from '//dev.jspm.io/native-promise-pool@3.28.0'
</script>
Editions
This package is published with the following editions:
native-promise-poolaliasesnative-promise-pool/index.cjswhich uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentnative-promise-pool/source/index.tsis TypeScript source code with Import for modulesnative-promise-pool/edition-browsers/index.jsis TypeScript compiled against ES2022 for web browsers with Import for modulesnative-promise-pool/edition-es2022/index.jsis TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesnative-promise-pool/edition-es2016/index.jsis TypeScript compiled against ES2016 for Node.js 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesnative-promise-pool/edition-es2022-esm/index.jsis TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulesnative-promise-pool/edition-types/index.d.tsis TypeScript compiled Types with Import for modulesnative-promise-pool/edition-deno/index.tsis TypeScript source code made to be compatible with Deno
History
Discover the release history by heading on over to the HISTORY.md file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md file.
Authors
- Benjamin Lupton — Accelerating collaborative wisdom.
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under: