[service-bus] Fix autoCompleteMessages help to indicate that it'll both completeMessage() and abandonMessage() (#15658)

Updating doc comment for autoComplete, indicating that it will abandon() if an error is thrown.

The prior text made it sound like it would call complete() no matter what happened, which was confusing.

Fixes #15519
This commit is contained in:
Richard Park 2021-06-09 19:01:00 -07:00 коммит произвёл GitHub
Родитель 0d451329fd
Коммит c300481e7c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 8 добавлений и 3 удалений

Просмотреть файл

@ -177,9 +177,14 @@ export interface GetMessageIteratorOptions extends OperationOptionsBase {}
*/
export interface SubscribeOptions extends OperationOptionsBase {
/**
* Indicates whether the message should be settled using the `completeMessage()`
* method on the receiver automatically after it executes the user provided message callback.
* Doing so removes the message from the queue/subscription.
* Indicates whether the message should be settled automatically based on the result from the
* user provided `processMessage` callback.
*
* - If an error is thrown from the `processMessage` callback the message will be abandoned
* using `receiver.abandonMessage()`. Doing so will make the message available again from the
* queue/subscription and the delivery count will be incremented.
* - If NO error is thrown from `processMessage` the message will be completed
* using `receiver.completeMessage()`. Doing so removes the message from the queue/subscription.
*
* This option is ignored if messages are received in the `receiveAndDelete` receive mode or if
* the message is already settled in the user provided message callback.