IMessage interface

Internal envelope of a queued message as it is stored in Redis: a generated id, the caller's payload, and the name of the queue that sent it.

Signature:

export interface IMessage 

Remarks

Consumers never receive this object. The message event delivers the payload, the id and the source queue name as three separate arguments.

Properties

Property

Modifiers

Type

Description

delay?

number

(Optional) Intended delay in milliseconds.

from

string

Name of the queue that produced the message.

id

string

Unique identifier assigned to the message when it was sent.

message

JsonObject

The message payload. Must be a JSON object — a bare string, number or array is not a valid message body.

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