Interface HaredoMessage<TMessage, TReply>

Type Parameters

  • TMessage = unknown

  • TReply = unknown

Hierarchy

  • Methods<TReply>
    • HaredoMessage

Properties

appId? consumerTag? contentEncoding? contentType? correlationId? data dataString deliveryCount? deliveryMode? deliveryTag emitter exchange? expiration? headers messageId? metaType priority? queue raw redelivered replyTo? routingKey? timestamp? type? userId?

Methods

ack getHeader getReply isAcked isHandled isNacked isReplied nack reply

Properties

Optional appId

appId?: string

An arbitrary identifier for the originating application

Optional consumerTag

consumerTag?: string

consumerTag of the consumer the message originates from

Optional contentEncoding

contentEncoding?: string

Optional contentType

contentType?: string

Optional correlationId

correlationId?: string

Used for RPC system to match messages to their replies

data

data: TMessage

Message contents

dataString

dataString: string

Unparsed message data

Optional deliveryCount

deliveryCount?: number

Amount of attempts the broker has done to deliver the message

Optional deliveryMode

deliveryMode?: 2 | 1

Either 1 for non-persistent or 2 for persistent

deliveryTag

deliveryTag: number

deliveryTag of the message (used to identify the message between consumer and broker)

emitter

emitter: TypedEventEmitter<HaredoMessageEvents>

Optional exchange

exchange?: string

Name of the exchange the message originates from

Optional expiration

expiration?: number

If supplied, the message will be discarded from a queue once it’s been there longer than the given number of milliseconds

headers

headers: MessagePropertyHeaders

Headers of the message

Optional messageId

messageId?: string

Arbitrary application-specific identifier for the message

metaType

metaType: "message"

Optional priority

priority?: number

Priority of a message. See priority queues

queue

queue: string

Name of the queue this message was consumed from

raw

raw: Message

Raw message from amqplib

redelivered

redelivered: boolean

True if the message has been sent to a consumer at least once

Optional replyTo

replyTo?: string

Queue name to reply to for RPC

Optional routingKey

routingKey?: string

Routingkey. If routingkey was not set then this equals to the name of the queue

Optional timestamp

timestamp?: number

A timestamp for the message

Optional type

type?: string

An arbitrary application-specific type for the message

Optional userId

userId?: string

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

Methods

ack

  • Mark the message as done, removes it from the queue

    Returns void

getHeader

  • Return the specified header

    Parameters

    • header: string

      header to return

    Returns string | string[]

getReply

isAcked

isHandled

isNacked

isReplied

  • Returns true if the message has been replied to (RPC)

    Returns boolean

nack

  • Nack the message. If requeue is false (defaults to true) then the message will be discarded. Otherwise it will be returned to the front of the queue

    Parameters

    • Optional requeue: boolean

    Returns void

reply

  • Reply to the message. Only works if the message has a replyTo and correlationId have been set on the message. If autoReply has been set on the chain, then You can just return a non-undefined value from the subscribe callback

    Parameters

    • message: TReply

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc