nitro-queue

library0.0.7jsnpmunverified

A module for Nitro v3 that provides Cloudflare Queue support. It automatically configures queue routes by scanning a queues directory, generates TypeScript types for queue payloads, and handles routing from cloudflare:queue. Currently at version 0.0.7, it requires Nitro ^3.0.1-alpha.2 and has not been thoroughly tested. It differentiates by integrating directly with Nitro's module system and automating type generation with wrangler.

devops

npm install nitro-queue

package ↗

INSTALL

IMPORT

SIG · NITRO-QUEUE

nitro-queue

devopsjavascriptv0.0.7

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

defineQueue

✓ import { defineQueue } from 'nitro-queue'

✗ import defineQueue from 'nitro-queue'

Named export; default import is not available.

queue

✓ import queue from 'nitro-queue'

✗ import { queue } from 'nitro-queue'

Default export for module configuration in nitro.config.ts.

Shows module setup, defining a queue handler, and sending a message from a route.

// nitro.config.ts import queue from 'nitro-queue' import { defineNitroConfig } from 'nitro/config' export default defineNitroConfig({ modules: [queue()], }) // queues/user/remove.ts import { defineQueue } from 'nitro-queue' export default defineQueue<{ userId: string }>({ run(payload) { console.log(payload.userId) } }) // routes/publish.ts import { defineHandler } from 'nitro/runtime' export default defineHandler(async (e) => { const userId = '123' e.runtime.cloudflare.env.MY_QUEUE.send({ type: 'user:remove', payload: { userId } }) })

Debug

Known issues

gotchaModule not thoroughly tested; may have bugs in production

fix

Test extensively before using in production; open issues for bugs.

affects: 0.0.7

breakingRequires Nitro v3 alpha.2 or later; incompatible with older versions

fix

Ensure Nitro version is ^3.0.1-alpha.2 or newer.

affects: 0.0.7

gotchaType generation requires wrangler to be run first

fix

Run 'wrangler types cloudflare.d.ts' before 'npx nitro-queue types cloudflare.d.ts'.

affects: 0.0.7

deprecatedThe module may become deprecated if Nitro changes queue handling

fix

Monitor Nitro and nitro-queue releases for updates.

affects: >=0.0.0

Errors

Common errors & fixes

Cannot find module 'nitro-queue' or its corresponding type declarations.

nitro-queue not installed or missing from dependencies.

fix

Run 'pnpm add nitro-queue' (or npm/yarn) and ensure it's listed in package.json.

Module "nitro-queue" has no exported member 'defineQueue'.

Using incorrect import syntax.

fix

Use import { defineQueue } from 'nitro-queue' (named import).

TypeError: queue is not a function

Incorrect usage of queue import in nitro config.

fix

Use 'import queue from "nitro-queue"' and call queue() as a function: modules: [queue()]

Type '"runtime.cloudflare.env.MY_QUEUE.send"' does not exist on ...

Cloudflare environment variables not properly typed or queue not bound.

fix

Generate Cloudflare types with wrangler and run 'npx nitro-queue types' to update cloudflare.d.ts.

Upgrade

Version history

0.0.7latest on npm

Audit

Dependencies

nitrorequiredPeer dependency; requires Nitro v3 alpha2 or later

Agent activity

4 hits · last 30 days

node

Resources

packagenitro-queue ↗