Next.js

App Router

app/api/queues/sample/route.ts

import { Queue } from "quirrel/next-app";

export const sampleQueue = Queue(
  "api/queues/sample",
  async (job, meta) => {
    // do something
  }
);

export const POST = sampleQueue;

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

Pages Router

pages/api/queues/sample.ts

import { Queue } from "quirrel/next-pages";

export default Queue("api/queues/sample", 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>

Parameter	Usage
path	The route that this queue is reachable at.
worker	a function that takes the job's payload and returns a Promise
defaultJobOptions	Optional. Use to set default options applied to every job.