Skip to main content

Blitz.js

Install Quirrel using the official Blitz Recipe: blitz install quirrel

app/api/someQueue.ts
import { Queue } from "quirrel/blitz";

export default Queue(
"api/someQueue",
async (job, meta) => {
// do something
}
);

Creates a new Queue. Make sure to export it from an API Route, otherwise it won't work.

Parameters

function Queue<T>(
path: string,
worker: (job: T, meta: JobMeta): Promise<void>,
defaultJobOptions?: { exclusive?: boolean }
): QueueInstance<T>
ParameterUsage
pathThe route that this queue is reachable at.
workera function that takes the job's payload and returns a Promise
defaultJobOptionsOptional. Use to set default options applied to every job.