API

Reference for module options, runtime config, helpers, and the CLI.

Imports

Use Nitro virtual aliases in server code, or import from the published runtime entry when typechecking with plain tsc (before Nitro generates types):

Import	Exports
#processor	defineQueue, defineWorker
#processor-utils	useProcessor, BullMQ types (Queue, Worker, Processor, …)
#bullmq	Re-exports from bullmq
nitro-processor/runtime	defineQueue, defineWorker, useProcessor, BullMQ types

import { defineQueue, defineWorker } from '#processor'
import { useProcessor } from 'nitro-processor/runtime'
import type { Job } from '#bullmq'

TypeScript

The package ships ambient declarations for #processor, #processor-utils, and #bullmq, plus a path map for plain tsc:

{
  "extends": ["nitro/tsconfig", "nitro-processor/tsconfig.paths.json"]
}

For project references (tsc -b), extend the same path map from your app tsconfig. The repo includes reference playgrounds under playground/nitro/ (standalone Nitro) and playground/vite-nitro/ (Vite + Nitro).

When the Nitro module is registered, types:extend adds the same paths to Nitro's generated tsconfig automatically.

Module options

Configure when registering the module in nitro.config.ts or vite.config.ts. See Configuration for Vite setup and buildDir.

import { defineConfig } from 'nitro/config'
import nitroProcessor from 'nitro-processor'

export default defineConfig({
  modules: [
    nitroProcessor({
      workers: 'server/workers',
    }),
  ],
})

interface ModuleOptions {
  /**
   * Folder scanned for worker files ({ts,js,mjs}).
   * @default 'server/workers'
   */
  workers?: string
}

Runtime config

Redis connection settings live on useRuntimeConfig().redis. See Redis configuration for REDIS_* (dev/build) vs NITRO_REDIS_* (runtime).

interface RuntimeConfig {
  redis: RedisOptions & { url?: string }
}

CLI

npx nitro-processor dev
npx nitro-processor dev --workers=basic,hello
npx nitro-processor dev --buildDir .nitro

Arg	Type	Purpose
dir	positional (default .)	Project root
--buildDir	string	Nitro buildDir relative to project root (disables auto-probe)
--workers	string	Comma-separated worker names filter
--nodeArgs	string	Extra Node flags (e.g. --inspect)
--verbose	boolean	Log resolved watch paths

Dev workers entry: {buildDir}/dev/workers/index.mjs (default node_modules/.nitro/dev/workers/index.mjs).

Prod workers entry: .output/server/workers/index.mjs.