V5 migration

The breaking change in this version is the removal of zehut from dependencies and usage as a peer-dependency. The required version of zehut is now ^4.0.0.

This was moved to being a peer-dependency in order to ensure that the version of zehut used here is the same as used in the MS, and not risk the package using v4 while the service is using v3, which would cause zehut to have multiple traces, which will not all hold the correct data.

Additionally, the minimum node version is now 18, due to the minimum version of node defined in zehut.

onNack hook

Called whenever a message is nacked — whether it's retried or sent to the dead-letter queue.

rabbit.consume('my-queue', async (msg, ack, nack) => {
  try {
    await processMessage(msg);
    await ack();
  } catch (error) {
    await nack(msg, { nackContext: { error: error.message, orderId: msg.content.id } });
  }
}, {
  retries: 3,
  onNack: ({ msg, retryCount, remainingRetries, sendToDeadQueue, nackContext }) => {
    logger.warn('message nacked', { retryCount, remainingRetries, sendToDeadQueue, nackContext });
  },
});

| Param | Type | Description | |---|---|---| | msg | Message | The parsed message | | retryCount | number | Current retry attempt number | | remainingRetries | number | Retries left before dead-letter | | sendToDeadQueue | boolean | true if the message is going to the dead-letter queue | | nackContext | Record<string, unknown> | Optional context passed from the consumer callback via nack() |