typescript 5.6.0-dev.20240719 → 5.6.0-dev.20240720

package/lib/lib.es2015.iterable.d.ts

@@ -38,39 +38,45 @@ interface IteratorReturnResult<TReturn> {
 
 type IteratorResult<T, TReturn = any> = IteratorYieldResult<T> | IteratorReturnResult<TReturn>;
 
-interface Iterator<T, TReturn = any, TNext = undefined> {
+interface Iterator<T, TReturn = any, TNext = any> {
     // NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.
-    next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
+    next(...[value]: [] | [TNext]): IteratorResult<T, TReturn>;
     return?(value?: TReturn): IteratorResult<T, TReturn>;
     throw?(e?: any): IteratorResult<T, TReturn>;
 }
 
-interface Iterable<T> {
-    [Symbol.iterator](): Iterator<T>;
+interface Iterable<T, TReturn = any, TNext = any> {
+    [Symbol.iterator](): Iterator<T, TReturn, TNext>;
 }
 
-interface IterableIterator<T> extends Iterator<T> {
-    [Symbol.iterator](): IterableIterator<T>;
+interface IterableIterator<T, TReturn = any, TNext = any> extends Iterator<T, TReturn, TNext> {
+    [Symbol.iterator](): IterableIterator<T, TReturn, TNext>;
 }
 
+interface BuiltinIterator<T, TReturn = any, TNext = any> extends Iterator<T, TReturn, TNext> {
+    [Symbol.iterator](): BuiltinIterator<T, TReturn, TNext>;
+}
+
+type BuiltinIteratorReturn = intrinsic;
+
 interface Array<T> {
     /** Iterator */
-    [Symbol.iterator](): IterableIterator<T>;
+    [Symbol.iterator](): BuiltinIterator<T, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, T]>;
+    entries(): BuiltinIterator<[number, T], BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of values in the array
      */
-    values(): IterableIterator<T>;
+    values(): BuiltinIterator<T, BuiltinIteratorReturn>;
 }
 
 interface ArrayConstructor {
@@ -91,67 +97,67 @@ interface ArrayConstructor {
 
 interface ReadonlyArray<T> {
     /** Iterator of values in the array. */
-    [Symbol.iterator](): IterableIterator<T>;
+    [Symbol.iterator](): BuiltinIterator<T, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, T]>;
+    entries(): BuiltinIterator<[number, T], BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of values in the array
      */
-    values(): IterableIterator<T>;
+    values(): BuiltinIterator<T, BuiltinIteratorReturn>;
 }
 
 interface IArguments {
     /** Iterator */
-    [Symbol.iterator](): IterableIterator<any>;
+    [Symbol.iterator](): BuiltinIterator<any, BuiltinIteratorReturn>;
 }
 
 interface Map<K, V> {
     /** Returns an iterable of entries in the map. */
-    [Symbol.iterator](): IterableIterator<[K, V]>;
+    [Symbol.iterator](): BuiltinIterator<[K, V], BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of key, value pairs for every entry in the map.
      */
-    entries(): IterableIterator<[K, V]>;
+    entries(): BuiltinIterator<[K, V], BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of keys in the map
      */
-    keys(): IterableIterator<K>;
+    keys(): BuiltinIterator<K, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of values in the map
      */
-    values(): IterableIterator<V>;
+    values(): BuiltinIterator<V, BuiltinIteratorReturn>;
 }
 
 interface ReadonlyMap<K, V> {
     /** Returns an iterable of entries in the map. */
-    [Symbol.iterator](): IterableIterator<[K, V]>;
+    [Symbol.iterator](): BuiltinIterator<[K, V], BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of key, value pairs for every entry in the map.
      */
-    entries(): IterableIterator<[K, V]>;
+    entries(): BuiltinIterator<[K, V], BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of keys in the map
      */
-    keys(): IterableIterator<K>;
+    keys(): BuiltinIterator<K, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of values in the map
      */
-    values(): IterableIterator<V>;
+    values(): BuiltinIterator<V, BuiltinIteratorReturn>;
 }
 
 interface MapConstructor {
@@ -167,40 +173,40 @@ interface WeakMapConstructor {
 
 interface Set<T> {
     /** Iterates over values in the set. */
-    [Symbol.iterator](): IterableIterator<T>;
+    [Symbol.iterator](): BuiltinIterator<T, BuiltinIteratorReturn>;
     /**
      * Returns an iterable of [v,v] pairs for every value `v` in the set.
      */
-    entries(): IterableIterator<[T, T]>;
+    entries(): BuiltinIterator<[T, T], BuiltinIteratorReturn>;
     /**
      * Despite its name, returns an iterable of the values in the set.
      */
-    keys(): IterableIterator<T>;
+    keys(): BuiltinIterator<T, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of values in the set.
      */
-    values(): IterableIterator<T>;
+    values(): BuiltinIterator<T, BuiltinIteratorReturn>;
 }
 
 interface ReadonlySet<T> {
     /** Iterates over values in the set. */
-    [Symbol.iterator](): IterableIterator<T>;
+    [Symbol.iterator](): BuiltinIterator<T, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of [v,v] pairs for every value `v` in the set.
      */
-    entries(): IterableIterator<[T, T]>;
+    entries(): BuiltinIterator<[T, T], BuiltinIteratorReturn>;
 
     /**
      * Despite its name, returns an iterable of the values in the set.
      */
-    keys(): IterableIterator<T>;
+    keys(): BuiltinIterator<T, BuiltinIteratorReturn>;
 
     /**
      * Returns an iterable of values in the set.
      */
-    values(): IterableIterator<T>;
+    values(): BuiltinIterator<T, BuiltinIteratorReturn>;
 }
 
 interface SetConstructor {
@@ -235,23 +241,23 @@ interface PromiseConstructor {
 
 interface String {
     /** Iterator */
-    [Symbol.iterator](): IterableIterator<string>;
+    [Symbol.iterator](): BuiltinIterator<string, BuiltinIteratorReturn>;
 }
 
 interface Int8Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Int8ArrayConstructor {
@@ -267,19 +273,19 @@ interface Int8ArrayConstructor {
 }
 
 interface Uint8Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Uint8ArrayConstructor {
@@ -295,21 +301,21 @@ interface Uint8ArrayConstructor {
 }
 
 interface Uint8ClampedArray {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
 
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
 
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Uint8ClampedArrayConstructor {
@@ -325,21 +331,21 @@ interface Uint8ClampedArrayConstructor {
 }
 
 interface Int16Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
 
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
 
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Int16ArrayConstructor {
@@ -355,19 +361,19 @@ interface Int16ArrayConstructor {
 }
 
 interface Uint16Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Uint16ArrayConstructor {
@@ -383,19 +389,19 @@ interface Uint16ArrayConstructor {
 }
 
 interface Int32Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Int32ArrayConstructor {
@@ -411,19 +417,19 @@ interface Int32ArrayConstructor {
 }
 
 interface Uint32Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Uint32ArrayConstructor {
@@ -439,19 +445,19 @@ interface Uint32ArrayConstructor {
 }
 
 interface Float32Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Float32ArrayConstructor {
@@ -467,19 +473,19 @@ interface Float32ArrayConstructor {
 }
 
 interface Float64Array {
-    [Symbol.iterator](): IterableIterator<number>;
+    [Symbol.iterator](): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an array of key, value pairs for every entry in the array
      */
-    entries(): IterableIterator<[number, number]>;
+    entries(): BuiltinIterator<[number, number], BuiltinIteratorReturn>;
     /**
      * Returns an list of keys in the array
      */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
     /**
      * Returns an list of values in the array
      */
-    values(): IterableIterator<number>;
+    values(): BuiltinIterator<number, BuiltinIteratorReturn>;
 }
 
 interface Float64ArrayConstructor {

package/lib/lib.es2018.asyncgenerator.d.ts

@@ -18,9 +18,9 @@ and limitations under the License.
 
 /// <reference lib="es2018.asynciterable" />
 
-interface AsyncGenerator<T = unknown, TReturn = any, TNext = unknown> extends AsyncIterator<T, TReturn, TNext> {
+interface AsyncGenerator<T = unknown, TReturn = any, TNext = any> extends AsyncBuiltinIterator<T, TReturn, TNext> {
     // NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.
-    next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
+    next(...[value]: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
     return(value: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>;
     throw(e: any): Promise<IteratorResult<T, TReturn>>;
     [Symbol.asyncIterator](): AsyncGenerator<T, TReturn, TNext>;

package/lib/lib.es2018.asynciterable.d.ts

@@ -27,17 +27,21 @@ interface SymbolConstructor {
     readonly asyncIterator: unique symbol;
 }
 
-interface AsyncIterator<T, TReturn = any, TNext = undefined> {
+interface AsyncIterator<T, TReturn = any, TNext = any> {
     // NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.
-    next(...args: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
+    next(...[value]: [] | [TNext]): Promise<IteratorResult<T, TReturn>>;
     return?(value?: TReturn | PromiseLike<TReturn>): Promise<IteratorResult<T, TReturn>>;
     throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
 }
 
-interface AsyncIterable<T> {
-    [Symbol.asyncIterator](): AsyncIterator<T>;
+interface AsyncIterable<T, TReturn = any, TNext = any> {
+    [Symbol.asyncIterator](): AsyncIterator<T, TReturn, TNext>;
 }
 
-interface AsyncIterableIterator<T> extends AsyncIterator<T> {
-    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+interface AsyncIterableIterator<T, TReturn = any, TNext = any> extends AsyncIterator<T, TReturn, TNext> {
+    [Symbol.asyncIterator](): AsyncIterableIterator<T, TReturn, TNext>;
+}
+
+interface AsyncBuiltinIterator<T, TReturn = any, TNext = any> extends AsyncIterator<T, TReturn, TNext> {
+    [Symbol.asyncIterator](): AsyncBuiltinIterator<T, TReturn, TNext>;
 }

package/lib/lib.es2020.bigint.d.ts

@@ -171,7 +171,7 @@ interface BigInt64Array {
     copyWithin(target: number, start: number, end?: number): this;
 
     /** Yields index, value pairs for every entry in the array. */
-    entries(): IterableIterator<[number, bigint]>;
+    entries(): BuiltinIterator<[number, bigint], BuiltinIteratorReturn>;
 
     /**
      * Determines whether all the members of an array satisfy the specified test.
@@ -256,7 +256,7 @@ interface BigInt64Array {
     join(separator?: string): string;
 
     /** Yields each index in the array. */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
 
     /**
      * Returns the index of the last occurrence of a value in an array.
@@ -378,9 +378,9 @@ interface BigInt64Array {
     valueOf(): BigInt64Array;
 
     /** Yields each value in the array. */
-    values(): IterableIterator<bigint>;
+    values(): BuiltinIterator<bigint, BuiltinIteratorReturn>;
 
-    [Symbol.iterator](): IterableIterator<bigint>;
+    [Symbol.iterator](): BuiltinIterator<bigint, BuiltinIteratorReturn>;
 
     readonly [Symbol.toStringTag]: "BigInt64Array";
 
@@ -443,7 +443,7 @@ interface BigUint64Array {
     copyWithin(target: number, start: number, end?: number): this;
 
     /** Yields index, value pairs for every entry in the array. */
-    entries(): IterableIterator<[number, bigint]>;
+    entries(): BuiltinIterator<[number, bigint], BuiltinIteratorReturn>;
 
     /**
      * Determines whether all the members of an array satisfy the specified test.
@@ -528,7 +528,7 @@ interface BigUint64Array {
     join(separator?: string): string;
 
     /** Yields each index in the array. */
-    keys(): IterableIterator<number>;
+    keys(): BuiltinIterator<number, BuiltinIteratorReturn>;
 
     /**
      * Returns the index of the last occurrence of a value in an array.
@@ -650,9 +650,9 @@ interface BigUint64Array {
     valueOf(): BigUint64Array;
 
     /** Yields each value in the array. */
-    values(): IterableIterator<bigint>;
+    values(): BuiltinIterator<bigint, BuiltinIteratorReturn>;
 
-    [Symbol.iterator](): IterableIterator<bigint>;
+    [Symbol.iterator](): BuiltinIterator<bigint, BuiltinIteratorReturn>;
 
     readonly [Symbol.toStringTag]: "BigUint64Array";
 

package/lib/lib.es2020.string.d.ts

@@ -24,7 +24,7 @@ interface String {
      * containing the results of that search.
      * @param regexp A variable name or string literal containing the regular expression pattern and flags.
      */
-    matchAll(regexp: RegExp): IterableIterator<RegExpExecArray>;
+    matchAll(regexp: RegExp): BuiltinIterator<RegExpExecArray, BuiltinIteratorReturn>;
 
     /** Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. */
     toLocaleLowerCase(locales?: Intl.LocalesArgument): string;

package/lib/lib.es2020.symbol.wellknown.d.ts

@@ -33,5 +33,5 @@ interface RegExp {
      * containing the results of that search.
      * @param string A string to search within.
      */
-    [Symbol.matchAll](str: string): IterableIterator<RegExpMatchArray>;
+    [Symbol.matchAll](str: string): BuiltinIterator<RegExpMatchArray, BuiltinIteratorReturn>;
 }

package/lib/lib.es2022.intl.d.ts

@@ -55,7 +55,7 @@ declare namespace Intl {
         containing(codeUnitIndex?: number): SegmentData;
 
         /** Returns an iterator to iterate over the segments. */
-        [Symbol.iterator](): IterableIterator<SegmentData>;
+        [Symbol.iterator](): BuiltinIterator<SegmentData, BuiltinIteratorReturn>;
     }
 
     interface SegmentData {

package/lib/lib.esnext.d.ts

@@ -26,3 +26,4 @@ and limitations under the License.
 /// <reference lib="esnext.array" />
 /// <reference lib="esnext.regexp" />
 /// <reference lib="esnext.string" />
+/// <reference lib="esnext.iterator" />