Interface: BroadcastOptions
Defined in: glide-mq/src/types.ts:176
Configuration options for a Broadcast (pub/sub) queue.
Extends
Properties
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
compression?
compression?: "gzip" | "none";Defined in: glide-mq/src/types.ts:94
Enable transparent compression of job data. Default: 'none'.
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:105
Emit events (e.g., 'added') on the events stream when adding jobs. Default: true.
Inherited from
maxMessages?
maxMessages?: number;Defined in: glide-mq/src/types.ts:182
Max messages to retain in stream (must be a positive integer). Trimmed exactly (hard limit) on each publish, including messages a subscription has not read yet. Trimmed messages' job data is deleted once no subscription holds them. Opt-in; no trimming by default.
prefix?
prefix?: string;Defined in: glide-mq/src/types.ts:86
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.