Nutella with Pepperoni and Mushrooms
Miss any of our Open RFC calls?Watch the recordings here! »

native-promise-pool

3.16.0 • Public • Published

native-promise-pool

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Create a pool of a specified concurrency that accepts functions that return promises

Usage

Complete API Documentation.

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

Table Example Preview.

Table Example Source.

Simple Example

Simple Example Preview.

Simple Example Source.

Await Example

Await Example Preview.

Await Example Source.

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.16.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/native-promise-pool@^3.16.0'
</script> 

unpkg

<script type="module">
    import pkg from '//unpkg.com/native-promise-pool@^3.16.0'
</script> 

jspm

<script type="module">
    import pkg from '//dev.jspm.io/native-promise-pool@3.16.0'
</script> 

Editions

This package is published with the following editions:

  • native-promise-pool/source/index.ts is TypeScript source code with Import for modules
  • native-promise-pool/edition-browsers/index.js is TypeScript compiled against ES2019 for web browsers with Import for modules
  • native-promise-pool aliases native-promise-pool/edition-esnext/index.js
  • native-promise-pool/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 14 || 15 with Require for modules
  • native-promise-pool/edition-esnext-esm/index.js is TypeScript compiled against ESNext for Node.js 12 || 14 || 15 with Import for modules
  • native-promise-pool/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

Install

npm i native-promise-pool

DownloadsWeekly Downloads

3,785

Version

3.16.0

License

MIT

Unpacked Size

39 kB

Total Files

15

Last publish

Collaborators

  • avatar
  • avatar