Interface: BroadcastWorkerOptions
Defined in: glide-mq/src/types.ts:186
Configuration options for a BroadcastWorker (subscriber).
Extends
Properties
backoffStrategies?
backoffStrategies?: Record<string, (attemptsMade, err) => number>;Defined in: glide-mq/src/types.ts:156
Inherited from
WorkerOptions.backoffStrategies
batch?
batch?: BatchOptions;Defined in: glide-mq/src/types.ts:164
Enable batch processing. When set, the processor receives an array of jobs.
Inherited from
blockTimeout?
blockTimeout?: number;Defined in: glide-mq/src/types.ts:137
XREADGROUP BLOCK timeout in ms. A graceful close() of an idle worker waits up to this long for the in-flight read to return, so no job is claimed by a closed consumer.
Inherited from
client?
client?: Client;Defined in: glide-mq/src/types.ts:85
Pre-existing GLIDE client for non-blocking commands. When provided, the component does NOT own this client - close() will not destroy it. Must not be used for blocking reads (XREADGROUP BLOCK / XREAD BLOCK).
Inherited from
commandClient?
commandClient?: Client;Defined in: glide-mq/src/types.ts:131
Pre-existing GLIDE client for non-blocking commands (alias for client). The blocking client for XREADGROUP is always auto-created from connection. connection is required even when this is set. Provide either commandClient or client, not both.
Inherited from
compression?
compression?: "gzip" | "none";Defined in: glide-mq/src/types.ts:94
Enable transparent compression of job data. Default: 'none'.
Inherited from
concurrency?
concurrency?: number;Defined in: glide-mq/src/types.ts:132
Inherited from
connection?
connection?: ConnectionOptions;Defined in: glide-mq/src/types.ts:79
Connection options for creating a new client. Required unless client is provided.
Inherited from
deadLetterQueue?
deadLetterQueue?: DeadLetterQueueOptions;Defined in: glide-mq/src/types.ts:92
Dead letter queue configuration. On a Worker, jobs that fail terminally are copied to this queue. On a Queue, it only records the DLQ name for getDeadLetterJobs() and routes nothing.
Inherited from
events?
events?: boolean;Defined in: glide-mq/src/types.ts:169
Emit events to Valkey event stream on job completion/failure/retry/activation. Default: true. Set to false to skip XADD events in hot path (~1 fewer redis.call per job). 'failed', 'retrying' and 'stalled' stream events are still written. TS-side EventEmitter ('completed', 'failed', etc.) is unaffected.
Inherited from
globalConcurrency?
globalConcurrency?: number;Defined in: glide-mq/src/types.ts:133
Inherited from
WorkerOptions.globalConcurrency
limiter?
limiter?: object;Defined in: glide-mq/src/types.ts:141
duration
duration: number;max
max: number;Inherited from
lockDuration?
lockDuration?: number;Defined in: glide-mq/src/types.ts:160
Lock duration in ms. The worker sends a heartbeat every lockDuration/2. Jobs with a recent heartbeat are not reclaimed as stalled. Default: 30000 (30s).
Inherited from
maxStalledCount?
maxStalledCount?: number;Defined in: glide-mq/src/types.ts:139
Inherited from
metrics?
metrics?: boolean;Defined in: glide-mq/src/types.ts:172
Record per-minute timing metrics in Valkey on job completion and failure. Default: true. Set to false to skip HINCRBY metrics recording (~1-2 fewer redis.call per job).
Inherited from
prefetch?
prefetch?: number;Defined in: glide-mq/src/types.ts:135
XREADGROUP COUNT per poll. Capped at concurrency (concurrency * batch.size in batch mode); only a lower value changes behavior.
Inherited from
prefix?
prefix?: string;Defined in: glide-mq/src/types.ts:86
Inherited from
promotionInterval?
promotionInterval?: number;Defined in: glide-mq/src/types.ts:140
Inherited from
WorkerOptions.promotionInterval
sandbox?
sandbox?: SandboxOptions;Defined in: glide-mq/src/types.ts:162
Sandbox options for file-path processors. Only used when processor is a string.
Inherited from
serializer?
serializer?: Serializer;Defined in: glide-mq/src/types.ts:103
Custom serializer for job data and return values. Default: JSON.
Important: The same serializer must be used across all Queue, Worker, and FlowProducer instances that operate on the same queue. A mismatch causes silent data corruption - the consumer will see {} and the job's deserializationFailed flag will be true.
Inherited from
stalledInterval?
stalledInterval?: number;Defined in: glide-mq/src/types.ts:138
Inherited from
startFrom?
startFrom?: string;Defined in: glide-mq/src/types.ts:195
Stream ID to start from when creating this subscription.
- '$': Only new messages (default)
- '0-0': All history (backfill)
- '<stream-id>': Start from specific ID
subjects?
subjects?: string[];Defined in: glide-mq/src/types.ts:213
Subject patterns to filter messages. Only messages whose subject matches at least one pattern are delivered to the processor. Non-matching messages are auto-acknowledged and skipped (zero wasted HGETALL calls).
Pattern syntax (dot-separated segments):
*matches exactly one segment>matches one or more trailing segments (must be last token)- Literal segments match exactly
Examples:
'projects.>'matches'projects.1','projects.1.issues.2''projects.*'matches'projects.1'but not'projects.1.issues.2''projects.*.issues.>'matches'projects.1.issues.2'
When omitted, all messages are delivered (no filtering).
subscription
subscription: string;Defined in: glide-mq/src/types.ts:188
Subscription name - becomes the consumer group name. Required for broadcast workers.
tokenLimiter?
tokenLimiter?: object;Defined in: glide-mq/src/types.ts:145
Token-per-minute rate limiting. Tracks total tokens consumed per time window. Worker pauses fetching when either RPM limiter or TPM tokenLimiter is exceeded. Tokens reported via job.reportTokens() or auto-extracted from job.reportUsage().
duration
duration: number;Window duration in milliseconds.
maxTokens
maxTokens: number;Max tokens per window.
scope?
scope?: "queue" | "worker" | "both";Enforcement scope. Default: 'both'.
- 'queue': Valkey counter shared across all workers.
- 'worker': In-memory counter per worker.
- 'both': Local check first, then Valkey (optimal).