---
title: "@adonia/queue-bullmq API"
image: "https://adonia.pages.dev/og.png"
version: "next"
---

> Documentation Index
> Fetch the complete documentation index at: https://adonia.pages.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# @adonia/queue-bullmq API

<!-- Generated by docs/site/scripts/generate_api.ts. Do not edit. -->

Canonical inventory of every public subpath and TypeScript export in `@adonia/queue-bullmq`.

## `@adonia/queue-bullmq`

| Export | Kind | Source | Summary |
| --- | --- | --- | --- |
| `ADONIA_ACTION_DEAD_LETTER_JOB` | constant | `packages/queue-bullmq/src/index.ts:25` | Stable name used for entries copied to a dead-letter queue. |
| `ADONIA_ACTION_JOB` | constant | `packages/queue-bullmq/src/index.ts:23` | Stable job name, suitable for BullMQ dashboards and metrics. |
| `ADONIA_ACTION_JOB_DATA_MAX_BYTES` | constant | `packages/queue-bullmq/src/index.ts:27` | Default maximum serialized size of an action job's `data` object. |
| `ADONIA_ACTION_QUEUE` | constant | `packages/queue-bullmq/src/index.ts:21` | Default BullMQ queue name. |
| `BullMqAdoniaQueue` | class | `packages/queue-bullmq/src/index.ts:275` | Dispatch adapter bound as `adonia.queue`. |
| `BullMqAdoniaQueueOptions` | type-only interface | `packages/queue-bullmq/src/index.ts:225` | Options for the dispatch-side adapter, including every BullMQ queue option. |
| `BullMqAdoniaWorkerOptions` | type-only interface | `packages/queue-bullmq/src/index.ts:482` | Worker options combining the runtime with every BullMQ worker option. |
| `BullMqConnectionOptions` | type-only type | `packages/queue-bullmq/src/index.ts:30` | BullMQ's real Redis connection contract. |
| `BullMqDeadLetterJob` | type-only interface | `packages/queue-bullmq/src/index.ts:254` | JSON envelope written to the configured dead-letter queue. |
| `BullMqDeadLetterOptions` | type-only interface | `packages/queue-bullmq/src/index.ts:266` | Options for moving terminal failures to a dead-letter queue. |
| `BullMqFailedJob` | type-only type | `packages/queue-bullmq/src/index.ts:40` | Concrete failed job returned by `BullMqAdoniaQueue.listFailed`. |
| `BullMqGracefulShutdown` | type-only interface | `packages/queue-bullmq/src/index.ts:523` | Graceful-shutdown registration returned by `gracefulShutdown`. |
| `BullMqGracefulShutdownOptions` | type-only interface | `packages/queue-bullmq/src/index.ts:531` | Options for `gracefulShutdown`. |
| `BullMqJobsOptions` | type-only type | `packages/queue-bullmq/src/index.ts:32` | BullMQ's real per-job options contract. |
| `BullMqQueueEventHandlers` | type-only type | `packages/queue-bullmq/src/index.ts:42` | Progress, completion, and failure listeners accepted by `createQueueEvents`. |
| `BullMqQueueEventsOptions` | type-only interface | `packages/queue-bullmq/src/index.ts:465` | Options for queue-wide progress, completion, and failure events. |
| `BullMqQueueHealth` | type-only interface | `packages/queue-bullmq/src/index.ts:234` | Result returned by `BullMqAdoniaQueue.health`. |
| `BullMqQueueOptions` | type-only type | `packages/queue-bullmq/src/index.ts:34` | BullMQ's real producer options contract. |
| `BullMqRetryFailedOptions` | type-only interface | `packages/queue-bullmq/src/index.ts:247` | Options for retrying either one failed job or the queue's failed set. |
| `BullMqWorkerLike` | type-only type | `packages/queue-bullmq/src/index.ts:38` | Concrete BullMQ worker returned by `createAdoniaWorker`. |
| `BullMqWorkerOptions` | type-only type | `packages/queue-bullmq/src/index.ts:36` | BullMQ's real worker options contract. |
| `createAdoniaWorker` | function | `packages/queue-bullmq/src/index.ts:490` | Creates a BullMQ worker that accepts only validated `action-chunk` jobs. |
| `createQueueEvents` | function | `packages/queue-bullmq/src/index.ts:472` | Creates a QueueEvents connection and attaches the supplied operational listeners. |
| `gracefulShutdown` | function | `packages/queue-bullmq/src/index.ts:551` | Installs a one-shot SIGTERM handler that closes a worker within a bounded time. |

Source: https://adonia.pages.dev/reference/api/queue-bullmq/index.mdx