Skip to content

Interface: BroadcastOptions

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

Extends

Properties

client?

ts
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

QueueOptions.client


compression?

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

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

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

Inherited from

QueueOptions.compression


connection?

ts
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

QueueOptions.connection


deadLetterQueue?

ts
optional deadLetterQueue?: DeadLetterQueueOptions;

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

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

Inherited from

QueueOptions.deadLetterQueue


events?

ts
optional events?: boolean;

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

Emit events (e.g., 'added') on the events stream when adding jobs. Default: true.

Inherited from

QueueOptions.events


maxMessages?

ts
optional maxMessages?: number;

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

Max messages to retain in stream (must be a positive integer). Trimmed exactly (hard limit) on each publish. Opt-in; no trimming by default.


prefix?

ts
optional prefix?: string;

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

Inherited from

QueueOptions.prefix


serializer?

ts
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

QueueOptions.serializer

Released under the Apache-2.0 License.