add types for iterator helpers proposal #58222
+1,683
−340
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,133 @@ | ||||||
| interface NativeIterator<T, TReturn = void, TNext = undefined> extends Iterator<T, TReturn, TNext> { | ||||||
|
There was a problem hiding this comment. The word choose "Native" is not so good. Do we have other options? |
||||||
| /** | ||||||
| * Returns this iterator. | ||||||
| */ | ||||||
| [Symbol.iterator](): NativeIterator<T, TReturn, TNext>; | ||||||
|
|
||||||
| /** | ||||||
| * Creates an iterator whose values are the result of applying the callback to the values from this iterator. | ||||||
| * @param callbackfn A function that accepts up to two arguments to be used to transform values from the underlying iterator. | ||||||
| */ | ||||||
| map<U>(callbackfn: (value: T, index: number) => U): NativeIterator<U>; | ||||||
|
|
||||||
| /** | ||||||
| * Creates an iterator whose values are those from this iterator for which the provided predicate returns true. | ||||||
| * @param predicate A function that accepts up to two arguments to be used to test values from the underlying iterator. | ||||||
| */ | ||||||
| filter<S extends T>(predicate: (value: T, index: number) => value is S): NativeIterator<S>; | ||||||
|
|
||||||
| /** | ||||||
| * Creates an iterator whose values are those from this iterator for which the provided predicate returns true. | ||||||
| * @param predicate A function that accepts up to two arguments to be used to test values from the underlying iterator. | ||||||
| */ | ||||||
| filter(predicate: (value: T, index: number) => unknown): NativeIterator<T>; | ||||||
|
|
||||||
| /** | ||||||
| * Creates an iterator whose values are the values from this iterator, stopping once the provided limit is reached. | ||||||
| * @param limit The maximum number of values to yield. | ||||||
| */ | ||||||
| take(limit: number): NativeIterator<T>; | ||||||
|
|
||||||
| /** | ||||||
| * Creates an iterator whose values are the values from this iterator after skipping the provided count. | ||||||
| * @param count The number of values to drop. | ||||||
| */ | ||||||
| drop(count: number): NativeIterator<T>; | ||||||
|
|
||||||
| /** | ||||||
| * Creates an iterator whose values are the result of applying the callback to the values from this iterator and then flattening the resulting iterators or iterables. | ||||||
| * @param callback A function that accepts up to two arguments to be used to transform values from the underlying iterator into new iterators or iterables to be flattened into the result. | ||||||
| */ | ||||||
| flatMap<U>(callback: (value: T, index: number) => Iterator<U> | Iterable<U>): NativeIterator<U>; | ||||||
|
|
||||||
| /** | ||||||
| * Calls the specified callback function for all the elements in this iterator. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. | ||||||
| * @param callbackfn A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator. | ||||||
| * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of a value from the iterator. | ||||||
| */ | ||||||
| reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number) => T): T; | ||||||
| reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number) => T, initialValue: T): T; | ||||||
|
|
||||||
| /** | ||||||
| * Calls the specified callback function for all the elements in this iterator. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. | ||||||
| * @param callbackfn A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator. | ||||||
| * @param initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of a value from the iterator. | ||||||
| */ | ||||||
| reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number) => U, initialValue: U): U; | ||||||
|
|
||||||
| /** | ||||||
| * Creates a new array from the values yielded by this iterator. | ||||||
| */ | ||||||
| toArray(): Array<T>; | ||||||
|
|
||||||
| /** | ||||||
| * Performs the specified action for each element in the iterator. | ||||||
| * @param callbackfn A function that accepts up to two arguments. forEach calls the callbackfn function one time for each element in the iterator. | ||||||
| */ | ||||||
| forEach(callbackfn: (value: T, index: number) => void): void; | ||||||
|
|
||||||
| /** | ||||||
| * Determines whether the specified callback function returns true for any element of this iterator. | ||||||
| * @param predicate A function that accepts up to two arguments. The some method calls | ||||||
| * the predicate function for each element in this iterator until the predicate returns a value | ||||||
| * true, or until the end of the iterator. | ||||||
| */ | ||||||
| some(predicate: (value: T, index: number) => unknown): boolean; | ||||||
|
|
||||||
| /** | ||||||
| * Determines whether all the members of this iterator satisfy the specified test. | ||||||
| * @param predicate A function that accepts up to two arguments. The every method calls | ||||||
| * the predicate function for each element in this iterator until the predicate returns | ||||||
| * false, or until the end of this iterator. | ||||||
| */ | ||||||
| every(predicate: (value: T, index: number) => unknown): boolean; | ||||||
|
|
||||||
| /** | ||||||
| * Returns the value of the first element in this iterator where predicate is true, and undefined | ||||||
| * otherwise. | ||||||
| * @param predicate find calls predicate once for each element of this iterator, in | ||||||
| * order, until it finds one where predicate returns true. If such an element is found, find | ||||||
| * immediately returns that element value. Otherwise, find returns undefined. | ||||||
| */ | ||||||
| find<S extends T>(predicate: (value: T, index: number) => value is S): S | undefined; | ||||||
| find(predicate: (value: T, index: number) => unknown): T | undefined; | ||||||
|
|
||||||
| readonly [Symbol.toStringTag]: "Iterator"; | ||||||
|
There was a problem hiding this comment. I would suggest defining this as
Suggested change
otherwise subclasses of |
||||||
| } | ||||||
|
|
||||||
| interface IteratorConstructor { | ||||||
| /** | ||||||
| * Creates a native iterator from an iterator or iterable object. | ||||||
| * Returns its input if the input already inherits from the built-in Iterator class. | ||||||
| * @param value An iterator or iterable object to convert a native iterator. | ||||||
| */ | ||||||
| from<T>(value: Iterator<T> | Iterable<T>): NativeIterator<T>; | ||||||
| } | ||||||
|
|
||||||
| declare var Iterator: (abstract new <T>() => NativeIterator<T>) & IteratorConstructor; | ||||||
|
|
||||||
| // TODO BEFORE MERGING: update all existing IterableIterator-return methods to return NativeIterator | ||||||
|
There was a problem hiding this comment. As suggested elsewhere, I would suggest you define interface NativeIterator<T, TReturn = void, TNext = undefined> extends Iterator<T, TReturn, TNext> {
[Symbol.iterator](): NativeIterator<T, TReturn, TNext>;
}There was a problem hiding this comment. Should I split that into a separate PR, or do it here? |
||||||
| // I have only done a couple so far, for illustration | ||||||
|
|
||||||
| interface Generator<T = unknown, TReturn = any, TNext = unknown> extends NativeIterator<T, TReturn, TNext> { | ||||||
| } | ||||||
|
|
||||||
| interface Array<T> { | ||||||
| /** Iterator */ | ||||||
| [Symbol.iterator](): NativeIterator<T>; | ||||||
|
|
||||||
| /** | ||||||
| * Returns an iterable iterator of key, value pairs for every entry in the array | ||||||
| */ | ||||||
| entries(): NativeIterator<[number, T]>; | ||||||
|
|
||||||
| /** | ||||||
| * Returns an iterable iterator of keys in the array | ||||||
| */ | ||||||
| keys(): NativeIterator<number>; | ||||||
|
|
||||||
| /** | ||||||
| * Returns an iterable iterator of values in the array | ||||||
| */ | ||||||
| values(): NativeIterator<T>; | ||||||
| } | ||||||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
The
export {}trick mentioned in my earlier comment can address theabstract next()method definition.