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

[event-hubs] Update doc for subscription.close() to mention checkpoint store updating. #11345

Merged
merged 1 commit into from
Sep 18, 2020
Merged

[event-hubs] Update doc for subscription.close() to mention checkpoint store updating. #11345

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
4 changes: 4 additions & 0 deletions sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,10 @@ export interface SubscribeOptions {
export interface Subscription {
/**
* Stops the subscription from receiving more messages.
*
* If a checkpoint store has been configured this will also mark this subscription's
* partitions as abandoned, freeing them up to be read by other consumers.
*
* @returns Promise<void>
* @throws Error if the underlying connection encounters an error while closing.
*/
Expand Down