GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - poolifier/poolifier: Fast and small Node.js worker_threads and cluster worker pool

BranchesTags
Open more actions menu

Latest commit

 

History

7,762 Commits
7,762 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
.husky
.husky
 
 
.opencode
.opencode
 
 
.serena
.serena
 
 
.vscode
.vscode
 
 
.zed
.zed
 
 
benchmarks
benchmarks
 
 
docs
docs
 
 
examples
examples
 
 
images
images
 
 
src
src
 
 
tests
tests
 
 
.clean-publish
.clean-publish
 
 
.editorconfig
.editorconfig
 
 
.gitignore
.gitignore
 
 
.lintstagedrc.js
.lintstagedrc.js
 
 
.mise.toml
.mise.toml
 
 
AGENTS.md
AGENTS.md
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CLAUDE.md
CLAUDE.md
 
 
CODEOWNERS
CODEOWNERS
 
 
CODE_OF_CONDUCT.md
CODE_OF_CONDUCT.md
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
GEMINI.md
GEMINI.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
SECURITY.md
SECURITY.md
 
 
biome.json
biome.json
 
 
commitlint.config.js
commitlint.config.js
 
 
eslint.config.js
eslint.config.js
 
 
jsr.json
jsr.json
 
 
package.json
package.json
 
 
pnpm-lock.yaml
pnpm-lock.yaml
 
 
pnpm-workspace.yaml
pnpm-workspace.yaml
 
 
prepare.mjs
prepare.mjs
 
 
renovate.json
renovate.json
 
 
rollup.config.mjs
rollup.config.mjs
 
 
sonar-project.properties
sonar-project.properties
 
 
tea.yaml
tea.yaml
 
 
tsconfig.build.json
tsconfig.build.json
 
 
tsconfig.json
tsconfig.json
 
 
typedoc.json
typedoc.json
 
 
typedoc.mjs
typedoc.mjs
 
 
vitest.config.ts
vitest.config.ts
 
 

Repository files navigation

Node.js Worker_Threads and Cluster Worker Pool

GitHub commit activity (master) Npm Version JSR Version CI Workflow Code Coverage Quality Gate Status neostandard Javascript Code Style Discord Open Collective PRs Welcome No Dependencies

Why Poolifier?

Poolifier is used to perform CPU and/or I/O intensive tasks on Node.js servers, it implements worker pools using worker_threads and cluster Node.js modules.
With poolifier you can improve your performance and resolve problems related to the event loop.
Moreover you can execute your tasks using an API designed to improve the developer experience.
Please consult our general guidelines.

  • Easy to use ✅
  • Fixed and dynamic pool size ✅
  • Easy switch from a pool type to another ✅
  • Performance benchmarks ✅
  • No runtime dependencies ✅
  • Proper integration with Node.js async_hooks ✅
  • Support for CommonJS, ESM and TypeScript ✅
  • Support for worker_threads and cluster Node.js modules ✅
  • Tasks distribution strategies ✅
  • Lockless tasks queueing ✅
  • Queued tasks rescheduling:
    • Task stealing on idle ✅
    • Tasks stealing under back pressure ✅
    • Tasks redistribution on worker error ✅
  • Support for sync and async task function ✅
  • Support for abortable task function ✅
  • Support for multiple task functions:
    • Queuing priority ✅
    • Tasks distribution strategy ✅
    • Worker node affinity ✅
    • CRUD operations at runtime ✅
  • General guidelines on pool choice ✅
  • Error handling out of the box ✅
  • Widely tested ✅
  • Active community ✅
  • Code quality Bugs Code Smells Duplicated Lines (%) Maintainability Rating Reliability Rating Technical Debt
  • Code security Security Rating Vulnerabilities

Table of contents

  • Overview
  • Installation
  • Usage
  • Node.js versions
  • API
  • General guidelines
  • Worker choice strategies
  • Contribute
  • Team
  • License

Overview

Poolifier contains two worker_threads/cluster worker pool implementations, you don't have to deal with worker_threads/cluster complexity.
The first implementation is a fixed worker pool, with a defined number of workers that are started at creation time and will be reused.
The second implementation is a dynamic worker pool, with a number of worker started at creation time (these workers will be always active and reused) and other workers created when the load will increase (with an upper limit, these workers will be reused when active), the newly created workers will be stopped after a configurable period of inactivity.
You have to implement your worker by extending the ThreadWorker or ClusterWorker class.

Installation

npmjs

npm install poolifier --save

JSR

npx jsr add @poolifier/poolifier

Usage

You can implement a poolifier worker_threads worker in a simple way by extending the class ThreadWorker:

import { ThreadWorker } from 'poolifier'

function yourFunction(data) {
  // this will be executed in the worker thread,
  // the data will be received by using the execute method
  return { ok: 1 }
}

export default new ThreadWorker(yourFunction, {
  maxInactiveTime: 60000,
})

Instantiate your pool based on your needs :

import {
  DynamicThreadPool,
  FixedThreadPool,
  PoolEvents,
  availableParallelism,
} from 'poolifier'

// a fixed worker_threads pool
const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', {
  onlineHandler: () => console.info('worker is online'),
  errorHandler: e => console.error(e),
})

pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready'))
pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy'))

// or a dynamic worker_threads pool
const pool = new DynamicThreadPool(
  Math.floor(availableParallelism() / 2),
  availableParallelism(),
  './yourWorker.js',
  {
    onlineHandler: () => console.info('worker is online'),
    errorHandler: e => console.error(e),
  }
)

pool.emitter?.on(PoolEvents.full, () => console.info('Pool is full'))
pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready'))
pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy'))

// the execute method signature is the same for both implementations,
// so you can easily switch from one to another
try {
  const res = await pool.execute()
  console.info(res)
} catch (err) {
  console.error(err)
}

You can do the same with the classes ClusterWorker, FixedClusterPool and DynamicClusterPool.

See examples for more details:

  • Javascript
  • Typescript
    • HTTP client pool
    • SMTP client pool
    • HTTP server pool
      • Express worker_threads pool
      • Express cluster pool
      • Express hybrid pool
      • Fastify worker_threads pool
      • Fastify cluster pool
      • Fastify hybrid pool
    • WebSocket server pool
      • ws worker_threads pool
      • ws cluster pool
      • ws hybrid pool

Remember that workers can only send and receive structured-cloneable data.

Node.js versions

Supported Node.js versions are 22.18.0 or later in the 22.x line, or 24.3.0 and later.

API

General guidelines

Worker choice strategies

Contribute

Choose your task here, propose an idea, a fix, an improvement.

See CONTRIBUTING guidelines.

Team

Creator/Owner:

  • Alessandro Pio Ardizio

Maintainers:

  • Jérôme Benoit

Contributors:

  • Shinigami92

License

MIT

About

Fast and small Node.js worker_threads and cluster worker pool

poolifier.github.io/poolifier/

Topics

computingconcurrencycpueventloopjavascriptnodejsparallelismperformanceschedulingthreadpooltypescriptworker-pool

Resources

Readme
MIT license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

455 stars

Watchers

7 watching

Forks

18 forks
Report repository

Releases

Sponsor this project

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.