Consumer

Source: src/Cloudflare/Queues/Consumer.ts

A Cloudflare Queue Consumer that processes messages from a Queue.

Register a Worker as a consumer of a Queue. The Worker’s queue() handler will be invoked with batches of messages.

Cloudflare allows at most one Worker consumer per queue (HTTP-pull consumers can coexist). The reconciler enforces this: if the queue already has a Worker consumer pointing at a different script, the deploy fails with a clear error rather than silently adopting it.

Registering a Consumer

Basic consumer

const queue = yield* Cloudflare.Queues.Queue("MyQueue");
const worker = yield* Cloudflare.Worker("Worker", { ... });

yield* Cloudflare.Queues.Consumer("MyConsumer", {
  queueId: queue.queueId,
  scriptName: worker.workerName,
});

Consumer with settings

yield* Cloudflare.Queues.Consumer("MyConsumer", {
  queueId: queue.queueId,
  scriptName: worker.workerName,
  settings: {
    batchSize: 50,
    maxRetries: 5,
    maxWaitTimeMs: 10000,
  },
});