From 1ee399b65b2ca4bef9c3c92d38150f7079b86fc1 Mon Sep 17 00:00:00 2001 From: Thomas Aribart Date: Sun, 6 Aug 2023 15:39:09 +0200 Subject: [PATCH] fix typos in docs --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 447b5434..ab8541f1 100644 --- a/README.md +++ b/README.md @@ -972,11 +972,11 @@ await appMessageQueue.publishMessage({ > > The following methods interact with the messaging solution of your application through a `MessageQueueAdapter`. They will throw an `UndefinedMessageChannelAdapterError` if you did not provide one. > -> - publishMessage ((message: Message, opt?: OptionsObj = {}) => Promise\): Publish a `Message` (of the appropriate type) to the message queue. +> - publishMessage (message: Message, opt?: OptionsObj = {}) => Promise\): Publish a `Message` (of the appropriate type) to the message queue. > > `OptionsObj` contains the following properties: > -> - replay (?boolean): Signals that the event is not happening in real-time, e.g. in maintenance or migration operations. This information can be used downstream to react appropriately (e.g. prevent sending notification emails). Check the implementation of you adapter for more details. +> - replay (?boolean = false): Signals that the event is not happening in real-time, e.g. in maintenance or migration operations. This information can be used downstream to react appropriately. Check the implementation of you adapter for more details. > > - publishMessages (messages: Message[], opt?: OptionsObj) => Promise\): Publish several `Messages` (of the appropriate type) to the message queue. Options are similar to the `publishMessage` options. > @@ -1108,11 +1108,11 @@ await appMessageBus.publishMessage({ > > The following methods interact with the messaging solution of your application through a `MessageBusAdapter`. They will throw an `UndefinedMessageChannelAdapterError` if you did not provide one. > -> - publishMessage ((message: Message, opt?: OptionsObj = {}) => Promise\): Publish a `Message` (of the appropriate type) to the message bus. +> - publishMessage (message: Message, opt?: OptionsObj = {}) => Promise\): Publish a `Message` (of the appropriate type) to the message bus. > > `OptionsObj` contains the following properties: > -> - replay (?boolean): Signals that the event is not happening in real-time, e.g. in maintenance or migration operations. This information can be used downstream to react appropriately (e.g. prevent sending notification emails). Check the implementation of you adapter for more details. +> - replay (?boolean = false): Signals that the event is not happening in real-time, e.g. in maintenance or migration operations. This information can be used downstream to react appropriately. Check the implementation of you adapter for more details. > > - publishMessages (messages: Message[], opt?: OptionsObj) => Promise\): Publish several `Messages` (of the appropriate type) to the message bus. Options are similar to the `publishMessage` options. >