@pixel-brewery/archipel-platform-queue
Classes
| Class | Description |
|---|---|
| AzureQueue | Azure Service Bus queue implementation. |
| BullMqQueue | BullMQ-backed queue implementation. |
| MemoryQueue | In-memory FIFO queue implementation. |
| QueueError | Base error class for all queue-related errors. |
| QueueHealthIndicator | Health indicator for the queue infrastructure. |
| QueueJobNotFoundError | Thrown when a queue job cannot be found by its ID. |
| QueueJobStateError | Thrown when a queue job is in an invalid state for the requested transition. |
| QueueValidationError | Thrown when a queue operation receives invalid input. |
| VercelQueue | Vercel Queues implementation of the IQueue contract. |
Interfaces
| Interface | Description |
|---|---|
| IAzureQueueOptions | Configuration options for AzureQueue. |
| IBullMqQueueOptions | Configuration options for BullMqQueue. |
| IMemoryQueueOptions | Configuration options for MemoryQueue. |
| IQueue | Contract for queue implementations. |
| IQueueJob | Represents a job in a named queue with tracking metadata. |
| IVercelQueueOptions | Configuration options for VercelQueue. |
Type Aliases
| Type Alias | Description |
|---|---|
| QueueJobStatus | Union type derived from QUEUE_JOB_STATUS. |
Variables
| Variable | Description |
|---|---|
| AZURE_CONFIG_ENTRIES | All configuration entries required by the Azure queue provider. |
| AZURE_CONNECTION_STRING | Azure queue connection string. |
| AZURE_RECEIVE_WAIT_MS | Maximum wait time in milliseconds when receiving messages. |
| BULLMQ_CONFIG_ENTRIES | All configuration entries required by the BullMQ queue provider. |
| BULLMQ_PREFIX | Optional key prefix applied to all BullMQ queues in Redis. |
| BULLMQ_REDIS_URL | Redis connection URL for BullMQ. |
| PLATFORM_QUEUE_CONFIG_ENTRIES | All configuration entries required by platform-queue. |
| QUEUE_JOB_STATUS | Possible statuses of a queue job. |
| QUEUE_MAX_JOBS | Maximum number of jobs retained in the in-memory queue before eviction. |
| VERCEL_CONFIG_ENTRIES | All configuration entries required by the Vercel queue provider. |
| VERCEL_QUEUE_CONSUMER_GROUP | Consumer group name for receiving messages. |
| VERCEL_QUEUE_DEPLOYMENT_ID | Optional Vercel deployment ID for per-deployment message isolation. |
| VERCEL_QUEUE_REGION | Vercel region code (e.g. iad1, fra1, sfo1). |
| VERCEL_QUEUE_TOKEN | Vercel OIDC bearer token for queue authentication. |
| VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS | Visibility timeout in seconds for received messages. |