Interface MessageChain<TMessage>

metaType

appId

• appId(appId): MessageChain<TMessage>

• Set an arbitrary identifier for the originating application

  Parameters

  • appId: string

  Returns MessageChain<TMessage>

blindCarbonCopy

• blindCarbonCopy(...BCC): MessageChain<TMessage>

• Same as .carbonCopy but the value will not be sent in message headers to consumers

  Parameters

  • Rest ...BCC: string[]

  Returns MessageChain<TMessage>

carbonCopy

• carbonCopy(...CC): MessageChain<TMessage>

• Route the message to provided routing keys in addition to the main one

  Parameters

  • Rest ...CC: string[]

  Returns MessageChain<TMessage>

contentEncoding

• contentEncoding(contentEncoding): MessageChain<TMessage>

• Set a MIME encoding for the message content

  Parameters

  • contentEncoding: string

  Returns MessageChain<TMessage>

contentType

• contentType(contentType): MessageChain<TMessage>

• Set a MIME type for the message content

  Parameters

  • contentType: string

  Returns MessageChain<TMessage>

correlationId

• correlationId(correlationId): MessageChain<TMessage>

• Set a correlation id for the message (useful for an RPC scenario)

  Parameters

  • correlationId: string

  Returns MessageChain<TMessage>

delay

• delay(delay): MessageChain<TMessage>

• Set 'x-delay' header to delay a message in delayed exchanges

  Parameters

  • delay: number

  Returns MessageChain<TMessage>

expiration

• expiration(expiration): MessageChain<TMessage>

• Set the expiration time in milliseconds. The message will be discarded after it's been in the queue for longer than that

  Parameters

  • expiration: number

  Returns MessageChain<TMessage>

getState

• getState(): Partial<MessageChainState<TMessage>>

• Returns Partial<MessageChainState<TMessage>>

json

• json<TCustomMessage>(data?): MessageChain<TCustomMessage>

• Set content-type header to application/json. If content is provided it will be stringified and set as content

  Type Parameters

  • TCustomMessage = TMessage

  Parameters

  • Optional data: TCustomMessage

  Returns MessageChain<TCustomMessage>

mandatory

• mandatory(mandatory?): MessageChain<TMessage>

• Mandatory messages will be returned to sender if they're not routed Haredo doesn't implement basic.return yet so this will not do anything

  Parameters

  • Optional mandatory: boolean

  Returns MessageChain<TMessage>

messageId

• messageId(messageId): MessageChain<TMessage>

• Arbitrary application-specific identifier for the message

  Parameters

  • messageId: string

  Returns MessageChain<TMessage>

persistent

• persistent(persistent?): MessageChain<TMessage>

• persistent messages survive broker restarts provided it's in a queue that also survives restarts

  Parameters

  • Optional persistent: boolean

  Returns MessageChain<TMessage>

priority

• priority(priority): MessageChain<TMessage>

• A priority for the message. Only works with priority queues

  Parameters

  • priority: number

  Returns MessageChain<TMessage>

rawContent

• rawContent(rawContent): MessageChain<TMessage>

• Set string content of the message

  Parameters

  • rawContent: string

  Returns MessageChain<TMessage>

replyTo

• replyTo(replyTo): MessageChain<TMessage>

• Often used to name a queue to which the receiving application must send replies in an RPC scenario

  Parameters

  • replyTo: string

  Returns MessageChain<TMessage>

routingKey

• routingKey(routingKey): MessageChain<TMessage>

• Set routing key do determine how this message will be routed

  Parameters

  • routingKey: string

  Returns MessageChain<TMessage>

setHeader

• setHeader(header, value): MessageChain<TMessage>

• Set a specific message header

  Parameters

  • header: string

  • value: string | number

  Returns MessageChain<TMessage>

setHeaders

• setHeaders(headers): MessageChain<TMessage>

• Set message headers

  Parameters

  • headers: Record<string, any>

  Returns MessageChain<TMessage>

timestamp

• timestamp(timestamp): MessageChain<TMessage>

• A timestamp for the message

  Parameters

  • timestamp: number

  Returns MessageChain<TMessage>

type

• type(type): MessageChain<TMessage>

• An arbitrary application-specific type for the message

  Parameters

  • type: string

  Returns MessageChain<TMessage>

userId

• userId(userId): MessageChain<TMessage>

• If supplied, RabbitMQ will compare it to the username supplied when opening the connection and reject messages for which it does not match

  Parameters

  • userId: string

  Returns MessageChain<TMessage>