ProductStack Jobs

Simple, reliable, type-safe functions that can be dispatched as background jobs. Built on top of Upstash QStash.

Example

export const job = createJob("hello", async ({ name }: { name: string }) => {
  console.log(`Hello from the background, ${name}!`);
});

await job.dispatch({ name: "world" });

Motivation

This library aims to improve the developer experience when using QStash by treating jobs as first-class objects that can be dispatched. If you would like to learn more about the motivation behind this library, please read the blog post.

Get started

Before you get started, make sure you have your QStash token and signing keys.

Install the package

pnpm add @getproductstack/jobs

Create a route handler

// app/api/jobs/route.ts
import { Receiver } from "@upstash/qstash";
import { createHandler } from "@productstack/jobs/nextjs";

const receiver = new Receiver({
  nextSigningKey: process.env.QSTASH_NEXT_SIGNING_KEY,
  currentSigningKey: process.env.QSTASH_CURRENT_SIGNING_KEY,
})

export const { POST } = createHandler({
  receiver,
  jobs: [
    // jobs you define here
  ],
});

Configure the client

// lib/jobs.ts
import { Client } from "@upstash/qstash";
import { createManager } from "@productstack/jobs";

const client = new Client({
  token: process.env.QSTASH_TOKEN,
});

const { createJob } = createManager({
  client,
  // the URL for the route.ts you created in step 1
  endpoint: "https://my-app.com/api/jobs",
});

Define and register a job

export const myJob = createJob("my-job", async (payload: { name: string }) => {
  console.log(payload);
});

// app/api/queue/route.ts
export const { POST } = createHandler({
  jobs: [myJob],
});

Dispatch the job

await myJob.dispatch({ name: "world" });