Skip to content

Interface: QueueOptions ​

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

Configuration options for creating a Queue instance.

Extended by ​

Properties ​

client? ​

ts
optional 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).


compression? ​

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

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

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


connection? ​

ts
optional connection?: ConnectionOptions;

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

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


deadLetterQueue? ​

ts
optional 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.


events? ​

ts
optional events?: boolean;

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

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


prefix? ​

ts
optional prefix?: string;

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


serializer? ​

ts
optional 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.

Released under the Apache-2.0 License.