Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[service-bus] fix getMessageIterator docs #16957

Merged
merged 1 commit into from
Aug 24, 2021
Merged

[service-bus] fix getMessageIterator docs #16957

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions sdk/servicebus/service-bus/src/receivers/receiver.ts
View file
Open in desktop
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