ThreadPoolLite

A library for creating Web Worker pools.

Example

The example below displays 10 random numbers per 3 seconds.

/**
 * 
 *  Create 10 Workers 
 * 
 */
let tp = new ThreadPoolLite(20); 

/**
 * 
 *  Generate 20 tasks
 * 
 *  The task is to output a random number after 3 seconds
 *  of their current runtime.
 * 
 */
for(let i = 0; i < 20; i++){
    /**
     * 
     *    You can use raw functions or template strings
     *
     */
    tp.run(`function (){
        /**
         * 
         *  ThreadPoolLite workers can handle Promise
         *  objects, neat!
         * 
         */
        return new Promise(function (resolve, reject){
            setTimeout(function(){
                resolve(`+i+`);
            }, 3000)
        })
    }`).then(console.log)
}

Example Output:

19
18
16
15
17
13
14
8
5
10
9
4
2
0
6
1
12
11
7
3

Usage

Loading Module

NPM

npm i threadpool-lite

CDN

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/threadpool-lite@1.2.2/index.min.js"></script>

API

• ThreadPoolLite
  • new ThreadPoolLite(workerCount)
  • .run(runnable) ⇒ Promise
  • .terminate()
  • .getActiveCount()
  • .getIdleCount()

new ThreadPoolLite(workerCount)

Create a pool of workers, defaults to the amount of logical cores your hardware has.

Param	Type
workerCount	Integer

threadPoolLite.run(runnable) ⇒ Promise

Runs(or enqueues, if no idle workers are available) a task.

Tasks have scope of their own, and cannot access their parent scope.

Kind: instance method of ThreadPoolLite

Param	Type	Description
runnable	function	the task the worker receives

threadPoolLite.terminate()

Terminates all workers

Kind: instance method of ThreadPoolLite

threadPoolLite.getActiveCount()

Get the active workers count

Kind: instance method of ThreadPoolLite

threadPoolLite.getIdleCount()

Get the idle workers count

Kind: instance method of ThreadPoolLite

Changelogs

• 1.2.2
  • Fixed worker workload double-free
• 1.2.1
  • Fixed worker error handling
• 1.2.0
  • Proper error handling
• 1.1.0
  • Run method now returns a Promise.
• 1.0.0
  • Initial release

License

MIT License

Copyright (c) 2019 Alexis Munsayac

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.