graphile-worker-tasks

A utility for organizing and collecting graphile-worker tasks.

This library is particularly useful when working with graphile-worker in environments where the built-in file-based auto-discovery mechanism is either not possible or not desirable, such as when using bundlers or other specialized setups.

Install

pnpm add graphile-worker-tasks

Use

Define tasks:

import { defineTask } from "graphile-worker-tasks"

export default defineTask("sendEmail", async (email: string) => {
  console.log(`Sending email: ${email}`)
})

You can organize tasks across as many modules as needed.

Once defined, collect and run your tasks:

import { run } from "graphile-worker"
import { createTaskList, mergeTasks } from "graphile-worker-tasks"

import sendEmailTask from "../tasks/sendEmail"

const tasks = mergeTasks([
  sendEmailTask,
  // ...
])

await run({
  connectionString: "...",
  taskList: createTaskList(tasks),
  parsedCronItems: [],
})

Extend GraphileWorker.Tasks to ensure the graphile-worker tooling picks up the types:

declare global {
  namespace GraphileWorker {
    interface Tasks extends GraphileWorkerTasks<typeof tasks> {}
  }
}

There is no magic in this module — basically, it just stores the original task names and handles the typing quirks.

You can omit the helpers and use the task handlers directly, but make sure to use the correct names:

import { run } from "graphile-worker"

// Import the module under a name that matches the queue job name.
import sendEmail from "../tasks/sendEmail"

await run({
  connectionString: "...",
  taskList: {
    sendEmail, // The key here must match the queue job name.
    // ...
  },
  parsedCronItems: [],
})