@storebox/workers v2.0.3

boxy-workers

TL;DR

const workers = createWorkers()

workers.useInterval(
  (ctx) => {
    /* do stuff */
  },
  {
    interval: 200,
  },
)

workers.useCron(
  (ctx) => {
    /* do stuff */
  },
  {
    crontab: '* * * * * *',
  },
)

await workers.start()

/* ... */

await workers.stop()

Methods

createWorkers([options])

Create a new pool of workers.

Example

createWorkers({ state: { foo: 'bar' }, startupDuration: 30000 })

Options

#useInterval(func, [options])

Adds an "interval" worker to the workers pool. Interval workers execute a callback every X milliseconds.

Example

workers.useInterval(
  ({ name, shouldWorkerStop, state, app: { state: appState } }) => {
    /* do stuff */
  },
  {
    interval: 200,
    /* state */
    /* name */
    /* workAtStartup */
  },
)

Function

The worker function.

Options

#useCron(func, [options])

Adds a "cron" worker to the workers pool. Cron workers execute a callback at specific times, as defined by the crontab rule.

Example

workers.useCron(
  ({ name, shouldWorkerStop, state, app: { state: appState } }) => {
    /* do stuff */
  },
  {
    crontab: '* * * * * *',
    /* options */
    /* state */
    /* name */
  },
)

Function

The worker function.

Options

#start()

Starts the workers pool. You can await this method to wait for all workers setups to be done.

Example

await workers.start()

#stop()

Stops the workers pool. You can await this method to wait for all workers to be stopped.

Example

await workers.stop()

#onError(func)

Adds and event handler when an error happens.

Example

workers.onError((error, ctx) => {
  /* do stuff */
})

Function parameters

#useBeforeStart(func)

Calls a function hook before the workers initialization has started. If you use an async function, all workers will start after your function has run.

Example

workers.useBeforeStart((ctx) => {
  /* do stuff */
})

Function parameters