Cloudflare Queue

Configure Queue

Register the Nitro module and set queue.provider to cloudflare:

import { defineNitroConfig } from 'nitro/config'

export default defineNitroConfig({
  modules: ['@vitehub/queue/nitro'],
  queue: {
    provider: 'cloudflare',
  },
})

Understand generated names

Queue derives Cloudflare queue names and producer binding names from the discovered queue name.

For welcome-email:

Use these helpers when another config file needs the exact values:

import {
  getCloudflareQueueBindingName,
  getCloudflareQueueName,
} from '@vitehub/queue'

console.log(getCloudflareQueueName('welcome-email'))
console.log(getCloudflareQueueBindingName('welcome-email'))

Use an explicit binding name

Use queue.binding when you already provide one binding manually:

export default defineNitroConfig({
  modules: ['@vitehub/queue/nitro'],
  queue: {
    provider: 'cloudflare',
    binding: 'WELCOME_EMAIL_QUEUE',
  },
})

runQueue() resolves the binding from the current Cloudflare request environment.

Process batches

Cloudflare delivers batches of messages. Queue turns each message into a QueueJob and calls the discovered handler.

import { defineQueue } from '@vitehub/queue'

export default defineQueue<{ email: string }>(async (job) => {
  console.log(job.id, job.payload.email)
}, {
  concurrency: 4,
})

Use onError to control message retry behavior when a handler throws:

export default defineQueue(handler, {
  onError(error, message) {
    if (message.attempts >= 3) {
      return 'ack'
    }

    return { retry: { delaySeconds: 60 } }
  },
})

By default, failed messages are retried.

Generated output

For Cloudflare Nitro presets, the module adds Cloudflare queue producers and consumers to Nitro's generated Wrangler config.

Verify the provider

Call a route that enqueues a known queue:

curl -X POST http://localhost:3000/api/welcome \
  -H 'content-type: application/json' \
  -d '{"email":"ava@example.com","template":"vip"}'

Successful publishing returns a queued result:

{
  "ok": true,
  "result": {
    "status": "queued",
    "messageId": "queue_7f1b6f8e-7b5c-4c5e-b3a1-8d6a4b3d4c2a"
  }
}