native-promise-pool

native-promise-pool

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 Source.

Simple Example

Simple Example Source.

Await Example

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

Skypack

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

unpkg

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

jspm

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

Editions

This package is published with the following editions:

• native-promise-pool aliases native-promise-pool/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
• 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 ES2022 for web browsers with Import for modules
• native-promise-pool/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• native-promise-pool/edition-es2021/index.js is TypeScript compiled against ES2021 for Node.js 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
• native-promise-pool/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
• native-promise-pool/edition-types/index.d.ts is TypeScript compiled Types 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:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

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

License

Unless stated otherwise all works are:

• Copyright © 2018+ Benjamin Lupton

and licensed under:

• Artistic License 2.0