@pcs/prospect-queueworkerbase

Base implementation of the worker processes

---

Usage:

Create a node module that requires sk-worker.

This should contain a class that extends SkWorker and optionally overrides any of the listed functions.

Each override should receive the job and resolve a promise to the job:

beforeJob(job)

This is called when a job is picked from the queue to be processed. Any changes to be made to the job before it is processed should be made here.

processJob(job)

This is called to actually process a job. The functionality that the job needs to achieve should be here.

afterJob(job)

This is called after a job is processed, regardless of whether it succeeds or fails. Any clean up required following the processing of a job should be here.

completeJob(job)

This is called after a job is completed successfully.

erroredJob(job)

This is called after a job errors.

---

Processing Jobs

processJobs should be called on the worker, passing the queue name to process, the details of the redis server hosting the queue and the log level at which to output.

Example app.js

const config = require('./config/local.js')
const Worker = require('./lib/worker')
const worker = new Worker()

worker.processJobs(
  'housekeeping.createIndex',
  config.redisConnection,
  config.log.level
)

Example minimal local.js

module.exports = {
  redisConnection: {
    port: 6379,
    host: 'localhost'
  },
  log: {
    level: 'debug'
  }
}

---

License:

The MIT License (MIT)
Copyright © 2022 Press Computer Systems Ltd.

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.