interface WorkersQueueArm
Since 0.2.0

Wires a Cloudflare Queues producer binding up as the application's IQueue under CAPABILITIES.QUEUE.

Producing is all this arm configures. Consuming needs the Worker module to export the handler createQueueHandler(app) builds, which no plugin option can do on the application's behalf.

Properties

readonly
binding: string

The Queues producer binding name from wrangler.toml.

readonly
optional
name: string

Instance name. 'default' (the default) claims the bare queue token; anything else derives queue.<name>, which QueueHandlerOptions.name must then match.

readonly
optional
maxDelaySeconds: number

Largest accepted AddJobOptions.delayMs, in seconds. Defaults to 86400, the platform maximum; a larger delay throws rather than being silently truncated.

Usage

import { type WorkersQueueArm } from "cloudflare-plugin/src/index.ts";