native-promise-pool

native-promise-pool

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

Install

npm

• Install: npm install --save native-promise-pool
• Require: require('native-promise-pool')

jspm

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

Editions

This package is published with the following editions:

• native-promise-pool aliases native-promise-pool/source/index.js
• native-promise-pool/source/index.js is esnext source code with require for modules
• native-promise-pool/edition-browsers/index.js is esnext compiled for browsers with require for modules

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

Usage

API Documentation.

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 can provide compatibility via two methods.

By passing PromiseClass:

const pool = require('native-promise-pool').create({
    concurrency: 2,
    PromiseClass: require('bluebird')
})

Or by adding direct support to the builtin Promise class:

require('promise.prototype.finally').shim()
const pool = require('native-promise-pool').create({concurrency: 2})

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

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:

• MIT License