Interface: QueueMessage

A message as the drivers carry it: its queue, its id, its encoded body, its headers (the queue's own are x-lkt-*), and its delivery options.

Properties

body

body: Uint8Array

The body, encoded by the codec of the queue.

---

dedupe?

optional dedupe?: boolean

Drop the message when one of the same id is kept (dedupe).

---

delay?

optional delay?: number

The delay before its first delivery, in milliseconds.

---

group?

optional group?: string

The only group the message is delivered to: a copy sent again for the next attempt of that group (by the drivers which cannot deliver again after a delay). Without it, every group of the queue receives the message.

---

headers

headers: Record<string, string>

The headers.

---

id

id: string

The id of the message (its job id).

---

key?

optional key?: string

Its ordering key.

---

name

name: string

The queue.

---

priority?

optional priority?: number

Its priority (greater first).