Class RabbitMqInboxWriter

Base class for message handlers to handle incoming messages from the subscribed queue. *

Hierarchy (View Summary)

MessageHandler<unknown>
- RabbitMqInboxWriter

Index

Constructors

Properties

logger messageType middleware overrides? ownerPool storeInboxMessage

Methods

backwardCompatibilityMapper mapError? onMessage onMessageFailure?

Constructors

constructor

new RabbitMqInboxWriter(
    storeInboxMessage: StoreInboxMessage,
    ownerPool: Pool,
    logger: InboxOutboxLogger,
    customizations?: InboxWriterCustomizations,
): RabbitMqInboxWriter
Creates a new RabbitMQ-based handler that receives all events and commands and stores them in the transactional inbox.
Parameters
- storeInboxMessage: StoreInboxMessage
  Function to store the incoming RabbitMQ message in the transactional inbox
- ownerPool: Pool
- logger: InboxOutboxLogger
- Optionalcustomizations: InboxWriterCustomizations
  Provide custom logic on how the inbox writer should process messages
Returns RabbitMqInboxWriter
Overrides MessageHandler.constructor

Properties

`Protected`logger

logger: InboxOutboxLogger

`Readonly`messageType

messageType: string

`Readonly`middleware

middleware: OnMessageMiddleware<unknown>[]

`Optional` `Readonly`overrides

overrides?: SubscriptionConfig

`Protected`ownerPool

ownerPool: Pool

`Protected`storeInboxMessage

storeInboxMessage: StoreInboxMessage

Function to store the incoming RabbitMQ message in the transactional inbox

Methods

backwardCompatibilityMapper

backwardCompatibilityMapper(
acceptedMessageSettings?: MessagingSettings[],
): Dict<string>
Parameters
- OptionalacceptedMessageSettings: MessagingSettings[]
Returns Dict<string>

`Optional`mapError

mapError?(error: unknown): Error
Function to map thrown error of unspecified type to a more human-readable error. Defining this mapping function eliminates the need to wrap onMessage contents into an explicit try-catch block.
Parameters
- error: unknown
Returns Error
Inherited from MessageHandler.mapError

onMessage

onMessage(payload: unknown, message: MessageInfo<unknown>): Promise<void>
Store the incoming message in the transactional inbox.
Parameters
- payload: unknown
- message: MessageInfo<unknown>
Returns Promise<void>
Overrides MessageHandler.onMessage

`Optional`onMessageFailure

onMessageFailure?(
    payload: unknown,
    message: MessageInfo<unknown>,
    error: Error,
): Promise<void>
Function that will be called after the last retry attempt has failed. Useful for handling errors in an explicit way.
Parameters
- payload: unknown
  non-binary message payload (usually a json)
- message: MessageInfo<unknown>
  message with all related message metadata, including message envelope
- error: Error
  error object that caused message processing to repeatedly fail
Returns Promise<void>
Inherited from MessageHandler.onMessageFailure