@xgsd/transport-bullmq

BullMQ transport for @xgsd/workers.

Install

Install this package with:

yarn add @xgsd/transport-bullmq

Usage

Here's how to use this transport with your BullMQ project:

import {Queue, Worker} from 'bullmq'
import {createWorkerTransport} from '@xgsd/transport-bullmq'

const queue = new Queue('QUEUE', {
  connection: {
    host: 'localhost',
    port: 6379,
  },
})

createWorkerTransport({
  queue: 'QUEUE',
  transport: {
    entry: './worker.js',
    // ... normal options
  },
  worker: Worker,
  workerConfig: {
    connection: {
      host: 'localhost',
      port: 6379,
    },
    // ... normal BullMQ worker config
  },
})

Versioning

Workers follows Semantic Versioning (SemVer).

• Patch releases (1.0.x) contain fixes, documentation updates, and non-breaking improvements.
• Minor releases (1.x.0) add new functionality without breaking existing APIs.
• Major releases (x.0.0) contain breaking changes or behavioural changes to public APIs.

Pre-release versions such as 1.0.0-beta.0 are used during stabilisation phases before a stable release.

Once a stable major version is released, breaking changes will only happen through a new major release.

Stability

Workers is currently in active development, with the API stabilising towards v1.0.0.

Pre-release versions such as 1.0.0-beta.x are used to validate behaviour, improve documentation, and strengthen test coverage before the first stable release.

The goal for v1 is to provide a predictable and stable execution contract for running isolated Node.js workloads. Once v1.0.0 is released, breaking changes to public APIs will only happen through new major versions following Semantic Versioning (SemVer).

Internal implementation details may continue to evolve over time, but stability and backward compatibility of the public API will remain a priority.

Contributing

Issues, bug reports, and pull requests are welcome.

If you encounter a bug, please include:

• reproduction steps
• expected behaviour
• actual behaviour
• Node.js version
• operating system
• relevant logs or stack traces

For larger changes or feature ideas, open an issue first so the direction can be discussed before implementation work begins.

The goal of Workers is to keep execution predictable, simple, and easy to reason about — contributions should aim to preserve those properties.

License

MIT © Michael Palmer

You are free to use, modify, distribute, and build on this project, including for commercial use, provided the original copyright and license notice are preserved.

Documentation

Read the Documentation.