Interface: BroadcastWorkerOptions

Defined in: glide-mq/src/types.ts:136

Extends

• WorkerOptions

Properties

backoffStrategies?

optional backoffStrategies?: Record<string, (attemptsMade, err) => number>;

Defined in: glide-mq/src/types.ts:113

Inherited from

WorkerOptions.backoffStrategies

---

batch?

optional batch?: BatchOptions;

Defined in: glide-mq/src/types.ts:121

Enable batch processing. When set, the processor receives an array of jobs.

Inherited from

WorkerOptions.batch

---

blockTimeout?

optional blockTimeout?: number;

Defined in: glide-mq/src/types.ts:108

Inherited from

WorkerOptions.blockTimeout

---

client?

optional client?: Client;

Defined in: glide-mq/src/types.ts:71

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

WorkerOptions.client

---

commandClient?

optional commandClient?: Client;

Defined in: glide-mq/src/types.ts:104

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

WorkerOptions.commandClient

---

compression?

optional compression?: "none" | "gzip";

Defined in: glide-mq/src/types.ts:76

Enable transparent compression of job data. Default: 'none'.

Inherited from

WorkerOptions.compression

---

concurrency?

optional concurrency?: number;

Defined in: glide-mq/src/types.ts:105

Inherited from

WorkerOptions.concurrency

---

connection?

optional connection?: ConnectionOptions;

Defined in: glide-mq/src/types.ts:65

Connection options for creating a new client. Required unless client is provided.

Inherited from

WorkerOptions.connection

---

deadLetterQueue?

optional deadLetterQueue?: DeadLetterQueueOptions;

Defined in: glide-mq/src/types.ts:74

Dead letter queue configuration. Jobs that exhaust retries are moved here.

Inherited from

WorkerOptions.deadLetterQueue

---

events?

optional events?: boolean;

Defined in: glide-mq/src/types.ts:125

Emit events to Valkey event stream on job completion/activation. Default: true. Set to false to skip XADD events in hot path (~1 fewer redis.call per job). TS-side EventEmitter ('completed', 'failed', etc.) is unaffected.

Inherited from

WorkerOptions.events

---

globalConcurrency?

optional globalConcurrency?: number;

Defined in: glide-mq/src/types.ts:106

Inherited from

WorkerOptions.globalConcurrency

---

limiter?

optional limiter?: object;

Defined in: glide-mq/src/types.ts:112

duration

duration: number;

max

max: number;

Inherited from

WorkerOptions.limiter

---

lockDuration?

optional lockDuration?: number;

Defined in: glide-mq/src/types.ts:117

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

WorkerOptions.lockDuration

---

maxStalledCount?

optional maxStalledCount?: number;

Defined in: glide-mq/src/types.ts:110

Inherited from

WorkerOptions.maxStalledCount

---

metrics?

optional metrics?: boolean;

Defined in: glide-mq/src/types.ts:128

Record per-minute timing metrics in Valkey on job completion. Default: true. Set to false to skip HINCRBY metrics recording (~1-2 fewer redis.call per job).

Inherited from

WorkerOptions.metrics

---

prefetch?

optional prefetch?: number;

Defined in: glide-mq/src/types.ts:107

Inherited from

WorkerOptions.prefetch

---

prefix?

optional prefix?: string;

Defined in: glide-mq/src/types.ts:72

Inherited from

WorkerOptions.prefix

---

promotionInterval?

optional promotionInterval?: number;

Defined in: glide-mq/src/types.ts:111

Inherited from

WorkerOptions.promotionInterval

---

sandbox?

optional sandbox?: SandboxOptions;

Defined in: glide-mq/src/types.ts:119

Sandbox options for file-path processors. Only used when processor is a string.

Inherited from

WorkerOptions.sandbox

---

serializer?

optional serializer?: Serializer;

Defined in: glide-mq/src/types.ts:85

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

WorkerOptions.serializer

---

stalledInterval?

optional stalledInterval?: number;

Defined in: glide-mq/src/types.ts:109

Inherited from

WorkerOptions.stalledInterval

---

startFrom?

optional startFrom?: string;

Defined in: glide-mq/src/types.ts:145

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?

optional subjects?: string[];

Defined in: glide-mq/src/types.ts:163

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:138

Subscription name - becomes the consumer group name. Required for broadcast workers.