Skip to content

Commit

Permalink
[service-bus] fix getMessageIterator docs (#16957)
Browse files Browse the repository at this point in the history
  • Loading branch information
chradek authored Aug 24, 2021
1 parent 847e11f commit 8c62014
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions sdk/servicebus/service-bus/src/receivers/receiver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,8 @@ export interface ServiceBusReceiver {

/**
* Returns an iterator that can be used to receive messages from Service Bus.
* If the iterator is not able to fetch a new message in over a minute, `undefined` will be returned.
*
* @param options - A set of options to control the receive operation.
* - `maxWaitTimeInMs`: The time to wait to receive the message in each iteration.
* - `abortSignal`: The signal to use to abort the ongoing operation.
*
* @throws Error if the underlying connection, client or receiver is closed.
Expand Down

0 comments on commit 8c62014

Please sign in to comment.