IMQOptions.useGzip property

Enable message compression for serialization. Increases a worker CPU load but decreases network traffic between workers and the queue host. Defaults to false.

Signature:

useGzip?: boolean;

Remarks

Must be set identically on every producer and consumer of a queue: a mismatch makes deserialization fail, which emits an error event with the event name OnMessage and drops the message — permanently, even under IMQOptions.safeDelivery: a message that cannot be unpacked reaches no listener, so nothing is pending on it and its lease is released at once. Re-delivering it would only fail the same way.

Applies to queue messages only. IMessageQueue.publish() and IMessageQueue.subscribe() payloads are always plain JSON.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.