update iterator zip typings and test baselines

Author: a-tarasyuk

tsc/internal/bundled/libs/lib.esnext.iterator.d.ts

@@ -40,25 +40,24 @@ interface IteratorZipLongestOptions<T> {
 interface IteratorZipStrictOptions {
     /**
      * Requires every input to yield the same number of values.
+     * If not, a `TypeError` will be thrown when an input is exhausted before others.
      */
     mode: "strict";
 }
 
-type IteratorZipOptions<T> = IteratorZipShortestOptions | IteratorZipLongestOptions<T> | IteratorZipStrictOptions;
+type IteratorZipOptions<T> =
+    | IteratorZipShortestOptions
+    | IteratorZipLongestOptions<T>
+    | IteratorZipStrictOptions;
 
 type IteratorInput<T> = Iterable<T> | Iterator<T>;
 
-type IteratorYield<T extends IteratorInput<unknown>> =
-    T extends Iterable<infer U, any, any> ? U :
-    T extends Iterator<infer U, any, any> ? U :
-    never;
+type IteratorInputTuple = readonly [] | readonly [IteratorInput<unknown>, ...IteratorInput<unknown>[]];
 
-type IteratorZipResult<T extends readonly IteratorInput<unknown>[]> = {
-    -readonly [K in keyof T]: IteratorYield<T[K]>;
-};
+type IteratorYield<T> = T extends IteratorInput<infer U> ? U : never;
 
-type IteratorZipKeyedResult<T extends { readonly [K in keyof T]: IteratorInput<unknown> }> = {
-    -readonly [K in keyof T]: IteratorYield<T[K]>;
+type IteratorZipResult<T, TExtra = never> = {
+    -readonly [K in keyof T]: IteratorYield<T[K]> | TExtra;
 };
 
 declare global {
@@ -97,20 +96,24 @@ declare global {
          * @param iterables An iterable of iterators or iterables to zip.
          * @param options Controls how differing input lengths are handled.
          */
-        zip<T extends readonly IteratorInput<unknown>[] | []>(iterables: T, options?: IteratorZipOptions<NoInfer<Partial<IteratorZipResult<T>>>>): IteratorObject<IteratorZipResult<T>, undefined, unknown>;
+        zip<T extends IteratorInputTuple>(iterables: T, options: IteratorZipLongestOptions<NoInfer<IteratorZipResult<T>>> & { padding: NoInfer<IteratorZipResult<T>>; }): IteratorObject<IteratorZipResult<T>, undefined, unknown>;
+        zip<T extends readonly IteratorInput<unknown>[] | []>(iterables: T, options?: IteratorZipShortestOptions | IteratorZipStrictOptions): IteratorObject<IteratorZipResult<T>, undefined, unknown>;
+        zip<T extends readonly IteratorInput<unknown>[] | []>(iterables: T, options: IteratorZipOptions<NoInfer<Partial<IteratorZipResult<T>>>>): IteratorObject<IteratorZipResult<T, undefined>, undefined, unknown>;
 
         /**
          * Creates an iterator whose values are arrays containing values yielded at the same position by each input iterator or iterable.
          * @param iterables An iterable of iterators or iterables to zip.
          * @param options Controls how differing input lengths are handled.
          */
-        zip<T extends IteratorInput<unknown>>(iterables: Iterable<T>, options?: IteratorZipOptions<NoInfer<Iterable<IteratorYield<T>>>>): IteratorObject<IteratorYield<T>[], undefined, unknown>;
+        zip<T extends IteratorInput<unknown>>(iterables: Iterable<T>, options?: IteratorZipShortestOptions | IteratorZipStrictOptions): IteratorObject<IteratorYield<T>[], undefined, unknown>;
+        zip<T extends IteratorInput<unknown>>(iterables: Iterable<T>, options: IteratorZipOptions<NoInfer<Iterable<IteratorYield<T>>>>): IteratorObject<(IteratorYield<T> | undefined)[], undefined, unknown>;
 
         /**
          * Creates an iterator whose values are objects containing values yielded at the same position by each iterator or iterable in the input object.
          * @param iterables An object whose enumerable own properties contain iterators or iterables to zip.
          * @param options Controls how differing input lengths are handled.
          */
-        zipKeyed<T extends { readonly [K in keyof T]: IteratorInput<unknown> }>(iterables: T, options?: IteratorZipOptions<NoInfer<Partial<IteratorZipKeyedResult<T>>>>): IteratorObject<IteratorZipKeyedResult<T>, undefined, unknown>;
+        zipKeyed<T extends object>(iterables: T & Record<keyof T, IteratorInput<unknown>>, options?: IteratorZipShortestOptions | (IteratorZipLongestOptions<NoInfer<IteratorZipResult<T>>> & { padding: NoInfer<IteratorZipResult<T>>; }) | IteratorZipStrictOptions): IteratorObject<IteratorZipResult<T>, undefined, unknown>;
+        zipKeyed<T extends object>(iterables: T & Record<keyof T, IteratorInput<unknown>>, options: IteratorZipOptions<NoInfer<Partial<IteratorZipResult<T>>>>): IteratorObject<IteratorZipResult<T, undefined>, undefined, unknown>;
     }
 }

tsc/testdata/baselines/reference/compiler/iteratorChunks.errors.txt

@@ -0,0 +1,10 @@
+iteratorChunks.ts(3,33): error TS2345: Argument of type 'string' is not assignable to parameter of type 'number'.
+
+
+==== iteratorChunks.ts (1 errors) ====
+    const chunks: number[][] = Iterator.from([1, 2, 3]).chunks(2).toArray();
+    
+    Iterator.from([1, 2, 3]).chunks("2");
+                                    ~~~
+!!! error TS2345: Argument of type 'string' is not assignable to parameter of type 'number'.
+    

tsc/testdata/baselines/reference/compiler/iteratorChunks.js

@@ -3,12 +3,10 @@
 //// [iteratorChunks.ts]
 const chunks: number[][] = Iterator.from([1, 2, 3]).chunks(2).toArray();
 
-// @ts-expect-error chunk size must be a number
 Iterator.from([1, 2, 3]).chunks("2");
 
 
 //// [iteratorChunks.js]
 "use strict";
 const chunks = Iterator.from([1, 2, 3]).chunks(2).toArray();
-// @ts-expect-error chunk size must be a number
 Iterator.from([1, 2, 3]).chunks("2");

tsc/testdata/baselines/reference/compiler/iteratorChunks.symbols

@@ -11,7 +11,6 @@ const chunks: number[][] = Iterator.from([1, 2, 3]).chunks(2).toArray();
 >chunks : Symbol(IteratorObject.chunks, Decl(lib.esnext.iterator.d.ts, --, --))
 >toArray : Symbol(IteratorObject.toArray, Decl(lib.es2025.iterator.d.ts, --, --))
 
-// @ts-expect-error chunk size must be a number
 Iterator.from([1, 2, 3]).chunks("2");
 >Iterator.from([1, 2, 3]).chunks : Symbol(IteratorObject.chunks, Decl(lib.esnext.iterator.d.ts, --, --))
 >Iterator.from : Symbol(IteratorConstructor.from, Decl(lib.es2025.iterator.d.ts, --, --))

tsc/testdata/baselines/reference/compiler/iteratorChunks.types

@@ -19,7 +19,6 @@ const chunks: number[][] = Iterator.from([1, 2, 3]).chunks(2).toArray();
 >2 : 2
 >toArray : () => number[][]
 
-// @ts-expect-error chunk size must be a number
 Iterator.from([1, 2, 3]).chunks("2");
 >Iterator.from([1, 2, 3]).chunks("2") : IteratorObject<number[], undefined, unknown>
 >Iterator.from([1, 2, 3]).chunks : (chunkSize: number) => IteratorObject<number[], undefined, unknown>

tsc/testdata/baselines/reference/compiler/iteratorIncludes.errors.txt

@@ -0,0 +1,16 @@
+iteratorIncludes.ts(4,35): error TS2345: Argument of type 'string' is not assignable to parameter of type 'number'.
+iteratorIncludes.ts(6,38): error TS2345: Argument of type 'string' is not assignable to parameter of type 'number'.
+
+
+==== iteratorIncludes.ts (2 errors) ====
+    const includes: boolean = Iterator.from([1, 2, 3]).includes(2);
+    const includesAfterSkipping: boolean = Iterator.from([1, 2, 3]).includes(2, 1);
+    
+    Iterator.from([1, 2, 3]).includes("1");
+                                      ~~~
+!!! error TS2345: Argument of type 'string' is not assignable to parameter of type 'number'.
+    
+    Iterator.from([1, 2, 3]).includes(2, "1");
+                                         ~~~
+!!! error TS2345: Argument of type 'string' is not assignable to parameter of type 'number'.
+    

tsc/testdata/baselines/reference/compiler/iteratorIncludes.js

@@ -4,18 +4,14 @@
 const includes: boolean = Iterator.from([1, 2, 3]).includes(2);
 const includesAfterSkipping: boolean = Iterator.from([1, 2, 3]).includes(2, 1);
 
-// @ts-expect-error the searched value must match the iterator value
 Iterator.from([1, 2, 3]).includes("1");
 
-// @ts-expect-error skipped elements must be a number
 Iterator.from([1, 2, 3]).includes(2, "1");
 
 
 //// [iteratorIncludes.js]
 "use strict";
 const includes = Iterator.from([1, 2, 3]).includes(2);
 const includesAfterSkipping = Iterator.from([1, 2, 3]).includes(2, 1);
-// @ts-expect-error the searched value must match the iterator value
 Iterator.from([1, 2, 3]).includes("1");
-// @ts-expect-error skipped elements must be a number
 Iterator.from([1, 2, 3]).includes(2, "1");

tsc/testdata/baselines/reference/compiler/iteratorIncludes.symbols

@@ -17,15 +17,13 @@ const includesAfterSkipping: boolean = Iterator.from([1, 2, 3]).includes(2, 1);
 >from : Symbol(IteratorConstructor.from, Decl(lib.es2025.iterator.d.ts, --, --))
 >includes : Symbol(IteratorObject.includes, Decl(lib.esnext.iterator.d.ts, --, --))
 
-// @ts-expect-error the searched value must match the iterator value
 Iterator.from([1, 2, 3]).includes("1");
 >Iterator.from([1, 2, 3]).includes : Symbol(IteratorObject.includes, Decl(lib.esnext.iterator.d.ts, --, --))
 >Iterator.from : Symbol(IteratorConstructor.from, Decl(lib.es2025.iterator.d.ts, --, --))
 >Iterator : Symbol(Iterator, Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2025.iterator.d.ts, --, --))
 >from : Symbol(IteratorConstructor.from, Decl(lib.es2025.iterator.d.ts, --, --))
 >includes : Symbol(IteratorObject.includes, Decl(lib.esnext.iterator.d.ts, --, --))
 
-// @ts-expect-error skipped elements must be a number
 Iterator.from([1, 2, 3]).includes(2, "1");
 >Iterator.from([1, 2, 3]).includes : Symbol(IteratorObject.includes, Decl(lib.esnext.iterator.d.ts, --, --))
 >Iterator.from : Symbol(IteratorConstructor.from, Decl(lib.es2025.iterator.d.ts, --, --))

tsc/testdata/baselines/reference/compiler/iteratorIncludes.types

@@ -32,7 +32,6 @@ const includesAfterSkipping: boolean = Iterator.from([1, 2, 3]).includes(2, 1);
 >2 : 2
 >1 : 1
 
-// @ts-expect-error the searched value must match the iterator value
 Iterator.from([1, 2, 3]).includes("1");
 >Iterator.from([1, 2, 3]).includes("1") : boolean
 >Iterator.from([1, 2, 3]).includes : (searchElement: number, skippedElements?: number) => boolean
@@ -47,7 +46,6 @@ Iterator.from([1, 2, 3]).includes("1");
 >includes : (searchElement: number, skippedElements?: number) => boolean
 >"1" : "1"
 
-// @ts-expect-error skipped elements must be a number
 Iterator.from([1, 2, 3]).includes(2, "1");
 >Iterator.from([1, 2, 3]).includes(2, "1") : boolean
 >Iterator.from([1, 2, 3]).includes : (searchElement: number, skippedElements?: number) => boolean

tsc/testdata/baselines/reference/compiler/iteratorJoin.errors.txt

@@ -0,0 +1,11 @@
+iteratorJoin.ts(4,31): error TS2345: Argument of type 'number' is not assignable to parameter of type 'string'.
+
+
+==== iteratorJoin.ts (1 errors) ====
+    const joined: string = Iterator.from([1, 2, 3]).join("-");
+    const joinedWithDefaultSeparator: string = Iterator.from([1, 2, 3]).join();
+    
+    Iterator.from([1, 2, 3]).join(0);
+                                  ~
+!!! error TS2345: Argument of type 'number' is not assignable to parameter of type 'string'.
+