Interface: QueueOptions

The options of a Queue (see buildQueueOptions).

Properties

codec?

optional codec?: "messagepack" | "json" | QueueCodec

The codec of the messages and the results: 'messagepack' (as @lakutata/nats), 'json', or a QueueCodec. A value it cannot encode (a bigint, a circular value) fails with a QueueInvalidMessageException: add() rejects, a result goes to the dead letter queue at once.

Default

'messagepack'

---

defaults?

optional defaults?: QueueDefaults

The defaults of the consumers.

---

driver?

optional driver?: QueueDriverOptions

The driver: its transport.

Default

{type: 'memory'}

---

requestTimeout?

optional requestTimeout?: Duration

How long request() waits for its reply, and result() for its result.

Default

'30s'

---

results?

optional results?: false | QueueResultsOptions

The results kept: false keeps none (result() then fails, request() still waits for the reply).

Default

{keep: '1d'}