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

Add BuiltinIteratorReturn to IterableIterator and AsyncIterableIterator return types #1713

Merged
merged 18 commits into from
Aug 8, 2024
Merged

Add BuiltinIteratorReturn to IterableIterator and AsyncIterableIterator return types #1713

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b7df2ac
Add BuiltinIteratorReturn to IterableIterator and AsyncIterableIterat…
rbuckton May 7, 2024
f4cb461
Update to use BuiltinIterator
rbuckton Jul 19, 2024
13ee015
Revert package.json
rbuckton Jul 19, 2024
b3feaf7
Merge branch 'main' into builtiniteratorreturn
rbuckton Jul 19, 2024
faa9be8
Update TS to nightly
jakebailey Jul 20, 2024
8245db1
Use 'BuiltinAsyncIterator' spelling
rbuckton Jul 22, 2024
fe02922
Temporarily use pr build for testing
rbuckton Jul 22, 2024
5b83895
Bump nightly
jakebailey Jul 23, 2024
80cb992
Update to match microsoft/TypeScript#59506
rbuckton Aug 5, 2024
76c181c
Formatting
rbuckton Aug 5, 2024
b6a6718
Bump typescript
rbuckton Aug 6, 2024
1864a71
Support typesVersions in @types/web et al
rbuckton Aug 6, 2024
b010afb
Update baseline tests to support legacy folder
rbuckton Aug 6, 2024
0c19a29
Merge branch 'main' into builtiniteratorreturn
rbuckton Aug 6, 2024
101623e
Accept baselines
rbuckton Aug 6, 2024
ee46158
Accept baselines
rbuckton Aug 6, 2024
f66fea8
Accept baselines
rbuckton Aug 6, 2024
91e30ab
Fix autoImport
rbuckton Aug 6, 2024
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: 2 additions & 2 deletions baselines/audioworklet.asynciterable.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
/////////////////////////////

interface ReadableStream<R = any> {
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>;
values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>;
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R, BuiltinIteratorReturn>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So BuiltinIteratorReturn can't be the default value to reduce verbosity?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can't be the default value because it's not the default behavior of any iterator, just the native ones provided by the host. User-defined iterables might not match that behavior, and we don't intend to break those cases unnecessarily.

values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R, BuiltinIteratorReturn>;
}
8 changes: 4 additions & 4 deletions baselines/audioworklet.iterable.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ interface MessageEvent<T = any> {
}

interface URLSearchParams {
[Symbol.iterator](): IterableIterator<[string, string]>;
[Symbol.iterator](): IterableIterator<[string, string], BuiltinIteratorReturn>;
/** Returns an array of key, value pairs for every entry in the search params. */
entries(): IterableIterator<[string, string]>;
entries(): IterableIterator<[string, string], BuiltinIteratorReturn>;
/** Returns a list of keys in the search params. */
keys(): IterableIterator<string>;
keys(): IterableIterator<string, BuiltinIteratorReturn>;
/** Returns a list of values in the search params. */
values(): IterableIterator<string>;
values(): IterableIterator<string, BuiltinIteratorReturn>;
}
12 changes: 6 additions & 6 deletions baselines/dom.asynciterable.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
/////////////////////////////

interface FileSystemDirectoryHandle {
[Symbol.asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle]>;
entries(): AsyncIterableIterator<[string, FileSystemHandle]>;
keys(): AsyncIterableIterator<string>;
values(): AsyncIterableIterator<FileSystemHandle>;
[Symbol.asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle], BuiltinIteratorReturn>;
entries(): AsyncIterableIterator<[string, FileSystemHandle], BuiltinIteratorReturn>;
keys(): AsyncIterableIterator<string, BuiltinIteratorReturn>;
values(): AsyncIterableIterator<FileSystemHandle, BuiltinIteratorReturn>;
}

interface ReadableStream<R = any> {
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>;
values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>;
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R, BuiltinIteratorReturn>;
values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R, BuiltinIteratorReturn>;
}
146 changes: 73 additions & 73 deletions baselines/dom.iterable.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,36 +23,36 @@ interface BaseAudioContext {
}

interface CSSKeyframesRule {
[Symbol.iterator](): IterableIterator<CSSKeyframeRule>;
[Symbol.iterator](): IterableIterator<CSSKeyframeRule, BuiltinIteratorReturn>;
}

interface CSSNumericArray {
[Symbol.iterator](): IterableIterator<CSSNumericValue>;
entries(): IterableIterator<[number, CSSNumericValue]>;
keys(): IterableIterator<number>;
values(): IterableIterator<CSSNumericValue>;
[Symbol.iterator](): IterableIterator<CSSNumericValue, BuiltinIteratorReturn>;
entries(): IterableIterator<[number, CSSNumericValue], BuiltinIteratorReturn>;
keys(): IterableIterator<number, BuiltinIteratorReturn>;
values(): IterableIterator<CSSNumericValue, BuiltinIteratorReturn>;
}

interface CSSRuleList {
[Symbol.iterator](): IterableIterator<CSSRule>;
[Symbol.iterator](): IterableIterator<CSSRule, BuiltinIteratorReturn>;
}

interface CSSStyleDeclaration {
[Symbol.iterator](): IterableIterator<string>;
[Symbol.iterator](): IterableIterator<string, BuiltinIteratorReturn>;
}

interface CSSTransformValue {
[Symbol.iterator](): IterableIterator<CSSTransformComponent>;
entries(): IterableIterator<[number, CSSTransformComponent]>;
keys(): IterableIterator<number>;
values(): IterableIterator<CSSTransformComponent>;
[Symbol.iterator](): IterableIterator<CSSTransformComponent, BuiltinIteratorReturn>;
entries(): IterableIterator<[number, CSSTransformComponent], BuiltinIteratorReturn>;
keys(): IterableIterator<number, BuiltinIteratorReturn>;
values(): IterableIterator<CSSTransformComponent, BuiltinIteratorReturn>;
}

interface CSSUnparsedValue {
[Symbol.iterator](): IterableIterator<CSSUnparsedSegment>;
entries(): IterableIterator<[number, CSSUnparsedSegment]>;
keys(): IterableIterator<number>;
values(): IterableIterator<CSSUnparsedSegment>;
[Symbol.iterator](): IterableIterator<CSSUnparsedSegment, BuiltinIteratorReturn>;
entries(): IterableIterator<[number, CSSUnparsedSegment], BuiltinIteratorReturn>;
keys(): IterableIterator<number, BuiltinIteratorReturn>;
values(): IterableIterator<CSSUnparsedSegment, BuiltinIteratorReturn>;
}

interface Cache {
Expand All @@ -74,72 +74,72 @@ interface CustomStateSet extends Set<string> {
}

interface DOMRectList {
[Symbol.iterator](): IterableIterator<DOMRect>;
[Symbol.iterator](): IterableIterator<DOMRect, BuiltinIteratorReturn>;
}

interface DOMStringList {
[Symbol.iterator](): IterableIterator<string>;
[Symbol.iterator](): IterableIterator<string, BuiltinIteratorReturn>;
}

interface DOMTokenList {
[Symbol.iterator](): IterableIterator<string>;
entries(): IterableIterator<[number, string]>;
keys(): IterableIterator<number>;
values(): IterableIterator<string>;
[Symbol.iterator](): IterableIterator<string, BuiltinIteratorReturn>;
entries(): IterableIterator<[number, string], BuiltinIteratorReturn>;
keys(): IterableIterator<number, BuiltinIteratorReturn>;
values(): IterableIterator<string, BuiltinIteratorReturn>;
}

interface DataTransferItemList {
[Symbol.iterator](): IterableIterator<DataTransferItem>;
[Symbol.iterator](): IterableIterator<DataTransferItem, BuiltinIteratorReturn>;
}

interface EventCounts extends ReadonlyMap<string, number> {
}

interface FileList {
[Symbol.iterator](): IterableIterator<File>;
[Symbol.iterator](): IterableIterator<File, BuiltinIteratorReturn>;
}

interface FontFaceSet extends Set<FontFace> {
}

interface FormData {
[Symbol.iterator](): IterableIterator<[string, FormDataEntryValue]>;
[Symbol.iterator](): IterableIterator<[string, FormDataEntryValue], BuiltinIteratorReturn>;
/** Returns an array of key, value pairs for every entry in the list. */
entries(): IterableIterator<[string, FormDataEntryValue]>;
entries(): IterableIterator<[string, FormDataEntryValue], BuiltinIteratorReturn>;
/** Returns a list of keys in the list. */
keys(): IterableIterator<string>;
keys(): IterableIterator<string, BuiltinIteratorReturn>;
/** Returns a list of values in the list. */
values(): IterableIterator<FormDataEntryValue>;
values(): IterableIterator<FormDataEntryValue, BuiltinIteratorReturn>;
}

interface HTMLAllCollection {
[Symbol.iterator](): IterableIterator<Element>;
[Symbol.iterator](): IterableIterator<Element, BuiltinIteratorReturn>;
}

interface HTMLCollectionBase {
[Symbol.iterator](): IterableIterator<Element>;
[Symbol.iterator](): IterableIterator<Element, BuiltinIteratorReturn>;
}

interface HTMLCollectionOf<T extends Element> {
[Symbol.iterator](): IterableIterator<T>;
[Symbol.iterator](): IterableIterator<T, BuiltinIteratorReturn>;
}

interface HTMLFormElement {
[Symbol.iterator](): IterableIterator<Element>;
[Symbol.iterator](): IterableIterator<Element, BuiltinIteratorReturn>;
}

interface HTMLSelectElement {
[Symbol.iterator](): IterableIterator<HTMLOptionElement>;
[Symbol.iterator](): IterableIterator<HTMLOptionElement, BuiltinIteratorReturn>;
}

interface Headers {
[Symbol.iterator](): IterableIterator<[string, string]>;
[Symbol.iterator](): IterableIterator<[string, string], BuiltinIteratorReturn>;
/** Returns an iterator allowing to go through all key/value pairs contained in this object. */
entries(): IterableIterator<[string, string]>;
entries(): IterableIterator<[string, string], BuiltinIteratorReturn>;
/** Returns an iterator allowing to go through all keys of the key/value pairs contained in this object. */
keys(): IterableIterator<string>;
keys(): IterableIterator<string, BuiltinIteratorReturn>;
/** Returns an iterator allowing to go through all values of the key/value pairs contained in this object. */
values(): IterableIterator<string>;
values(): IterableIterator<string, BuiltinIteratorReturn>;
}

interface Highlight extends Set<AbstractRange> {
Expand Down Expand Up @@ -180,14 +180,14 @@ interface MIDIOutputMap extends ReadonlyMap<string, MIDIOutput> {
}

interface MediaKeyStatusMap {
[Symbol.iterator](): IterableIterator<[BufferSource, MediaKeyStatus]>;
entries(): IterableIterator<[BufferSource, MediaKeyStatus]>;
keys(): IterableIterator<BufferSource>;
values(): IterableIterator<MediaKeyStatus>;
[Symbol.iterator](): IterableIterator<[BufferSource, MediaKeyStatus], BuiltinIteratorReturn>;
entries(): IterableIterator<[BufferSource, MediaKeyStatus], BuiltinIteratorReturn>;
keys(): IterableIterator<BufferSource, BuiltinIteratorReturn>;
values(): IterableIterator<MediaKeyStatus, BuiltinIteratorReturn>;
}

interface MediaList {
[Symbol.iterator](): IterableIterator<string>;
[Symbol.iterator](): IterableIterator<string, BuiltinIteratorReturn>;
}

interface MessageEvent<T = any> {
Expand All @@ -200,11 +200,11 @@ interface MessageEvent<T = any> {
}

interface MimeTypeArray {
[Symbol.iterator](): IterableIterator<MimeType>;
[Symbol.iterator](): IterableIterator<MimeType, BuiltinIteratorReturn>;
}

interface NamedNodeMap {
[Symbol.iterator](): IterableIterator<Attr>;
[Symbol.iterator](): IterableIterator<Attr, BuiltinIteratorReturn>;
}

interface Navigator {
Expand All @@ -219,31 +219,31 @@ interface Navigator {
}

interface NodeList {
[Symbol.iterator](): IterableIterator<Node>;
[Symbol.iterator](): IterableIterator<Node, BuiltinIteratorReturn>;
/** Returns an array of key, value pairs for every entry in the list. */
entries(): IterableIterator<[number, Node]>;
entries(): IterableIterator<[number, Node], BuiltinIteratorReturn>;
/** Returns an list of keys in the list. */
keys(): IterableIterator<number>;
keys(): IterableIterator<number, BuiltinIteratorReturn>;
/** Returns an list of values in the list. */
values(): IterableIterator<Node>;
values(): IterableIterator<Node, BuiltinIteratorReturn>;
}

interface NodeListOf<TNode extends Node> {
[Symbol.iterator](): IterableIterator<TNode>;
[Symbol.iterator](): IterableIterator<TNode, BuiltinIteratorReturn>;
/** Returns an array of key, value pairs for every entry in the list. */
entries(): IterableIterator<[number, TNode]>;
entries(): IterableIterator<[number, TNode], BuiltinIteratorReturn>;
/** Returns an list of keys in the list. */
keys(): IterableIterator<number>;
keys(): IterableIterator<number, BuiltinIteratorReturn>;
/** Returns an list of values in the list. */
values(): IterableIterator<TNode>;
values(): IterableIterator<TNode, BuiltinIteratorReturn>;
}

interface Plugin {
[Symbol.iterator](): IterableIterator<MimeType>;
[Symbol.iterator](): IterableIterator<MimeType, BuiltinIteratorReturn>;
}

interface PluginArray {
[Symbol.iterator](): IterableIterator<Plugin>;
[Symbol.iterator](): IterableIterator<Plugin, BuiltinIteratorReturn>;
}

interface RTCRtpTransceiver {
Expand All @@ -255,46 +255,46 @@ interface RTCStatsReport extends ReadonlyMap<string, any> {
}

interface SVGLengthList {
[Symbol.iterator](): IterableIterator<SVGLength>;
[Symbol.iterator](): IterableIterator<SVGLength, BuiltinIteratorReturn>;
}

interface SVGNumberList {
[Symbol.iterator](): IterableIterator<SVGNumber>;
[Symbol.iterator](): IterableIterator<SVGNumber, BuiltinIteratorReturn>;
}

interface SVGPointList {
[Symbol.iterator](): IterableIterator<DOMPoint>;
[Symbol.iterator](): IterableIterator<DOMPoint, BuiltinIteratorReturn>;
}

interface SVGStringList {
[Symbol.iterator](): IterableIterator<string>;
[Symbol.iterator](): IterableIterator<string, BuiltinIteratorReturn>;
}

interface SVGTransformList {
[Symbol.iterator](): IterableIterator<SVGTransform>;
[Symbol.iterator](): IterableIterator<SVGTransform, BuiltinIteratorReturn>;
}

interface SourceBufferList {
[Symbol.iterator](): IterableIterator<SourceBuffer>;
[Symbol.iterator](): IterableIterator<SourceBuffer, BuiltinIteratorReturn>;
}

interface SpeechRecognitionResult {
[Symbol.iterator](): IterableIterator<SpeechRecognitionAlternative>;
[Symbol.iterator](): IterableIterator<SpeechRecognitionAlternative, BuiltinIteratorReturn>;
}

interface SpeechRecognitionResultList {
[Symbol.iterator](): IterableIterator<SpeechRecognitionResult>;
[Symbol.iterator](): IterableIterator<SpeechRecognitionResult, BuiltinIteratorReturn>;
}

interface StylePropertyMapReadOnly {
[Symbol.iterator](): IterableIterator<[string, Iterable<CSSStyleValue>]>;
entries(): IterableIterator<[string, Iterable<CSSStyleValue>]>;
keys(): IterableIterator<string>;
values(): IterableIterator<Iterable<CSSStyleValue>>;
[Symbol.iterator](): IterableIterator<[string, Iterable<CSSStyleValue>], BuiltinIteratorReturn>;
entries(): IterableIterator<[string, Iterable<CSSStyleValue>], BuiltinIteratorReturn>;
keys(): IterableIterator<string, BuiltinIteratorReturn>;
values(): IterableIterator<Iterable<CSSStyleValue>, BuiltinIteratorReturn>;
}

interface StyleSheetList {
[Symbol.iterator](): IterableIterator<CSSStyleSheet>;
[Symbol.iterator](): IterableIterator<CSSStyleSheet, BuiltinIteratorReturn>;
}

interface SubtleCrypto {
Expand All @@ -313,25 +313,25 @@ interface SubtleCrypto {
}

interface TextTrackCueList {
[Symbol.iterator](): IterableIterator<TextTrackCue>;
[Symbol.iterator](): IterableIterator<TextTrackCue, BuiltinIteratorReturn>;
}

interface TextTrackList {
[Symbol.iterator](): IterableIterator<TextTrack>;
[Symbol.iterator](): IterableIterator<TextTrack, BuiltinIteratorReturn>;
}

interface TouchList {
[Symbol.iterator](): IterableIterator<Touch>;
[Symbol.iterator](): IterableIterator<Touch, BuiltinIteratorReturn>;
}

interface URLSearchParams {
[Symbol.iterator](): IterableIterator<[string, string]>;
[Symbol.iterator](): IterableIterator<[string, string], BuiltinIteratorReturn>;
/** Returns an array of key, value pairs for every entry in the search params. */
entries(): IterableIterator<[string, string]>;
entries(): IterableIterator<[string, string], BuiltinIteratorReturn>;
/** Returns a list of keys in the search params. */
keys(): IterableIterator<string>;
keys(): IterableIterator<string, BuiltinIteratorReturn>;
/** Returns a list of values in the search params. */
values(): IterableIterator<string>;
values(): IterableIterator<string, BuiltinIteratorReturn>;
}

interface WEBGL_draw_buffers {
Expand Down
12 changes: 6 additions & 6 deletions baselines/serviceworker.asynciterable.generated.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
/////////////////////////////

interface FileSystemDirectoryHandle {
[Symbol.asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle]>;
entries(): AsyncIterableIterator<[string, FileSystemHandle]>;
keys(): AsyncIterableIterator<string>;
values(): AsyncIterableIterator<FileSystemHandle>;
[Symbol.asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle], BuiltinIteratorReturn>;
entries(): AsyncIterableIterator<[string, FileSystemHandle], BuiltinIteratorReturn>;
keys(): AsyncIterableIterator<string, BuiltinIteratorReturn>;
values(): AsyncIterableIterator<FileSystemHandle, BuiltinIteratorReturn>;
}

interface ReadableStream<R = any> {
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>;
values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R>;
[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R, BuiltinIteratorReturn>;
values(options?: ReadableStreamIteratorOptions): AsyncIterableIterator<R, BuiltinIteratorReturn>;
}
Loading
Loading