-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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
[core-paging] Update the return type for "next" method in PagedAsyncIterableIterator #10599
Merged
HarshaNalluru
merged 4 commits into
Azure:master
from
HarshaNalluru:harshan/sb/issue/iterator-fixes
Aug 26, 2020
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
57d8c7c
Update the return type for "next" method in PagedAsyncIterableIterator
HarshaNalluru a13d579
Update sdk/core/core-paging/types/corePaging.d.ts
HarshaNalluru 3d29c93
Separate declaration files for core-paging to allow support for TS3.1
HarshaNalluru 355af3f
Changelog
HarshaNalluru File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
import "@azure/core-asynciterator-polyfill"; | ||
/** | ||
* @interface | ||
* An interface that tracks the settings for paged iteration | ||
*/ | ||
export interface PageSettings { | ||
/** | ||
* @member {string} [continuationToken] The token that keeps track of where to continue the iterator | ||
*/ | ||
continuationToken?: string; | ||
/** | ||
* @member {number} [pageSize] The size of the page during paged iteration | ||
*/ | ||
maxPageSize?: number; | ||
} | ||
/** | ||
* @interface | ||
* An interface that allows async iterable iteration both to completion and by page. | ||
*/ | ||
export interface PagedAsyncIterableIterator<T, PageT = T[], PageSettingsT = PageSettings> { | ||
/** | ||
* @member {Promise} [next] The next method, part of the iteration protocol | ||
*/ | ||
next(): Promise<IteratorResult<T>>; | ||
/** | ||
* @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol | ||
*/ | ||
[Symbol.asyncIterator](): PagedAsyncIterableIterator<T, PageT, PageSettingsT>; | ||
/** | ||
* @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time | ||
*/ | ||
byPage: (settings?: PageSettingsT) => AsyncIterableIterator<PageT>; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added separate .dts file for 3.1 to 3.5.
@jeremymeng @bterlson