Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
3 changes: 3 additions & 0 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45863,6 +45863,9 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {

let allIterationTypes: IterationTypes[] | undefined;
for (const constituent of (type as UnionType).types) {
if (!!(getReducedType(constituent).flags & TypeFlags.Never)) {
Copy link
Contributor

@Andarist Andarist Oct 22, 2025

Choose a reason for hiding this comment

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

q: what if all union members reduce to never? wouldn't this break a case like this?

declare const o2: ({ a: "foo" } & { a: "bar" }) | ({ b: "qwe" } & { b: "rty" });
const [el2] = o2; // error

Copy link
Author

Choose a reason for hiding this comment

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

You're right, in that case TS allows the destructuring and types el2 as never.

I went with an alternative solution: reduce the whole iterable-like type instead of the union members: 93fb716 (#62661).

Added this case to the test as well

continue;
}
const errorOutputContainer: ErrorOutputContainer | undefined = errorNode ? { errors: undefined } : undefined;
const iterationTypes = getIterationTypesOfIterableWorker(constituent, use, errorNode, errorOutputContainer);
if (iterationTypes === noIterationTypes) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
//// [tests/cases/compiler/iterableWithNeverAsUnionMember.ts] ////

=== iterableWithNeverAsUnionMember.ts ===
declare const o1: { a: "foo" } & { a: "bar" };
>o1 : Symbol(o1, Decl(iterableWithNeverAsUnionMember.ts, 0, 13))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 0, 19))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 0, 34))

const [el1] = o1; // error
>el1 : Symbol(el1, Decl(iterableWithNeverAsUnionMember.ts, 1, 7))
>o1 : Symbol(o1, Decl(iterableWithNeverAsUnionMember.ts, 0, 13))

// https://github.com/microsoft/TypeScript/issues/62462
declare var x: number[] | ({ t: "a" } & { t: "b" });
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 4, 11))
>t : Symbol(t, Decl(iterableWithNeverAsUnionMember.ts, 4, 28))
>t : Symbol(t, Decl(iterableWithNeverAsUnionMember.ts, 4, 41))

let [el2] = x; // ok
>el2 : Symbol(el2, Decl(iterableWithNeverAsUnionMember.ts, 5, 5))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 4, 11))

for (const elem of x) { // ok
>elem : Symbol(elem, Decl(iterableWithNeverAsUnionMember.ts, 7, 10))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 4, 11))

elem.toFixed();
>elem.toFixed : Symbol(Number.toFixed, Decl(lib.es5.d.ts, --, --))
>elem : Symbol(elem, Decl(iterableWithNeverAsUnionMember.ts, 7, 10))
>toFixed : Symbol(Number.toFixed, Decl(lib.es5.d.ts, --, --))
}

type Shape =
>Shape : Symbol(Shape, Decl(iterableWithNeverAsUnionMember.ts, 9, 1))

| { kind: "circle"; radius: number }
>kind : Symbol(kind, Decl(iterableWithNeverAsUnionMember.ts, 12, 5))
>radius : Symbol(radius, Decl(iterableWithNeverAsUnionMember.ts, 12, 21))

| { kind: "rectangle"; width: number; height: number };
>kind : Symbol(kind, Decl(iterableWithNeverAsUnionMember.ts, 13, 5))
>width : Symbol(width, Decl(iterableWithNeverAsUnionMember.ts, 13, 24))
>height : Symbol(height, Decl(iterableWithNeverAsUnionMember.ts, 13, 39))

type Circle = Shape & { kind: "circle" };
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))
>Shape : Symbol(Shape, Decl(iterableWithNeverAsUnionMember.ts, 9, 1))
>kind : Symbol(kind, Decl(iterableWithNeverAsUnionMember.ts, 15, 23))

function doStuffWithCircle(arg: Circle | [Circle, (newValue: Circle) => void]) {
>doStuffWithCircle : Symbol(doStuffWithCircle, Decl(iterableWithNeverAsUnionMember.ts, 15, 41))
>arg : Symbol(arg, Decl(iterableWithNeverAsUnionMember.ts, 17, 27))
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))
>newValue : Symbol(newValue, Decl(iterableWithNeverAsUnionMember.ts, 17, 51))
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))

if (Array.isArray(arg)) {
>Array.isArray : Symbol(ArrayConstructor.isArray, Decl(lib.es5.d.ts, --, --))
>Array : Symbol(Array, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.core.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --))
>isArray : Symbol(ArrayConstructor.isArray, Decl(lib.es5.d.ts, --, --))
>arg : Symbol(arg, Decl(iterableWithNeverAsUnionMember.ts, 17, 27))

let [value, setValue] = arg; // ok
>value : Symbol(value, Decl(iterableWithNeverAsUnionMember.ts, 19, 9))
>setValue : Symbol(setValue, Decl(iterableWithNeverAsUnionMember.ts, 19, 15))
>arg : Symbol(arg, Decl(iterableWithNeverAsUnionMember.ts, 17, 27))
}
}

function f1<T extends { a: "foo" } & { a: "bar" }>(x: T) {
>f1 : Symbol(f1, Decl(iterableWithNeverAsUnionMember.ts, 21, 1))
>T : Symbol(T, Decl(iterableWithNeverAsUnionMember.ts, 23, 12))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 23, 23))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 23, 38))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 23, 51))
>T : Symbol(T, Decl(iterableWithNeverAsUnionMember.ts, 23, 12))

let [y] = x; // error
>y : Symbol(y, Decl(iterableWithNeverAsUnionMember.ts, 24, 7))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 23, 51))
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
//// [tests/cases/compiler/iterableWithNeverAsUnionMember.ts] ////

=== iterableWithNeverAsUnionMember.ts ===
declare const o1: { a: "foo" } & { a: "bar" };
>o1 : never
> : ^^^^^
>a : "foo"
> : ^^^^^
>a : "bar"
> : ^^^^^

const [el1] = o1; // error
>el1 : never
> : ^^^^^
>o1 : never
> : ^^^^^

// https://github.com/microsoft/TypeScript/issues/62462
declare var x: number[] | ({ t: "a" } & { t: "b" });
>x : number[]
> : ^^^^^^^^
>t : "a"
> : ^^^
>t : "b"
> : ^^^

let [el2] = x; // ok
>el2 : number
> : ^^^^^^
>x : number[]
> : ^^^^^^^^

for (const elem of x) { // ok
>elem : number
> : ^^^^^^
>x : number[]
> : ^^^^^^^^

elem.toFixed();
>elem.toFixed() : string
> : ^^^^^^
>elem.toFixed : (fractionDigits?: number) => string
> : ^ ^^^ ^^^^^
>elem : number
> : ^^^^^^
>toFixed : (fractionDigits?: number) => string
> : ^ ^^^ ^^^^^
}

type Shape =
>Shape : Shape
> : ^^^^^

| { kind: "circle"; radius: number }
>kind : "circle"
> : ^^^^^^^^
>radius : number
> : ^^^^^^

| { kind: "rectangle"; width: number; height: number };
>kind : "rectangle"
> : ^^^^^^^^^^^
>width : number
> : ^^^^^^
>height : number
> : ^^^^^^

type Circle = Shape & { kind: "circle" };
>Circle : { kind: "circle"; radius: number; } & { kind: "circle"; }
> : ^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^
>kind : "circle"
> : ^^^^^^^^

function doStuffWithCircle(arg: Circle | [Circle, (newValue: Circle) => void]) {
>doStuffWithCircle : (arg: Circle | [Circle, (newValue: Circle) => void]) => void
> : ^ ^^ ^^^^^^^^^
>arg : ({ kind: "circle"; radius: number; } & { kind: "circle"; }) | [{ kind: "circle"; radius: number; } & { kind: "circle"; }, (newValue: Circle) => void]
> : ^^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^^^^ ^^ ^^^^^ ^
>newValue : { kind: "circle"; radius: number; } & { kind: "circle"; }
> : ^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^

if (Array.isArray(arg)) {
>Array.isArray(arg) : boolean
> : ^^^^^^^
>Array.isArray : (arg: any) => arg is any[]
> : ^ ^^ ^^^^^
>Array : ArrayConstructor
> : ^^^^^^^^^^^^^^^^
>isArray : (arg: any) => arg is any[]
> : ^ ^^ ^^^^^
>arg : ({ kind: "circle"; radius: number; } & { kind: "circle"; }) | [{ kind: "circle"; radius: number; } & { kind: "circle"; }, (newValue: Circle) => void]
> : ^^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^^^^ ^^ ^^^^^ ^

let [value, setValue] = arg; // ok
>value : { kind: "circle"; radius: number; } & { kind: "circle"; }
> : ^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^
>setValue : (newValue: Circle) => void
> : ^ ^^ ^^^^^
>arg : [{ kind: "circle"; radius: number; } & { kind: "circle"; }, (newValue: Circle) => void]
> : ^^^^^^^^^ ^^^^^^^^^^ ^^^^^^^^^^^^^^ ^^^^^^ ^^ ^^^^^ ^
}
}

function f1<T extends { a: "foo" } & { a: "bar" }>(x: T) {
>f1 : <T extends { a: "foo"; } & { a: "bar"; }>(x: T) => void
> : ^ ^^^^^^^^^ ^^ ^^ ^^^^^^^^^
>a : "foo"
> : ^^^^^
>a : "bar"
> : ^^^^^
>x : T
> : ^

let [y] = x; // error
>y : never
> : ^^^^^
>x : T
> : ^
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
iterableWithNeverAsUnionMember.ts(2,7): error TS2488: Type 'never' must have a '[Symbol.iterator]()' method that returns an iterator.
iterableWithNeverAsUnionMember.ts(25,7): error TS2488: Type 'T' must have a '[Symbol.iterator]()' method that returns an iterator.


==== iterableWithNeverAsUnionMember.ts (2 errors) ====
declare const o1: { a: "foo" } & { a: "bar" };
const [el1] = o1; // error
~~~~~
!!! error TS2488: Type 'never' must have a '[Symbol.iterator]()' method that returns an iterator.

// https://github.com/microsoft/TypeScript/issues/62462
declare var x: number[] | ({ t: "a" } & { t: "b" });
let [el2] = x; // ok

for (const elem of x) { // ok
elem.toFixed();
}

type Shape =
| { kind: "circle"; radius: number }
| { kind: "rectangle"; width: number; height: number };

type Circle = Shape & { kind: "circle" };

function doStuffWithCircle(arg: Circle | [Circle, (newValue: Circle) => void]) {
if (Array.isArray(arg)) {
let [value, setValue] = arg; // ok
}
}

function f1<T extends { a: "foo" } & { a: "bar" }>(x: T) {
let [y] = x; // error
~~~
!!! error TS2488: Type 'T' must have a '[Symbol.iterator]()' method that returns an iterator.
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
//// [tests/cases/compiler/iterableWithNeverAsUnionMember.ts] ////

=== iterableWithNeverAsUnionMember.ts ===
declare const o1: { a: "foo" } & { a: "bar" };
>o1 : Symbol(o1, Decl(iterableWithNeverAsUnionMember.ts, 0, 13))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 0, 19))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 0, 34))

const [el1] = o1; // error
>el1 : Symbol(el1, Decl(iterableWithNeverAsUnionMember.ts, 1, 7))
>o1 : Symbol(o1, Decl(iterableWithNeverAsUnionMember.ts, 0, 13))

// https://github.com/microsoft/TypeScript/issues/62462
declare var x: number[] | ({ t: "a" } & { t: "b" });
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 4, 11))
>t : Symbol(t, Decl(iterableWithNeverAsUnionMember.ts, 4, 28))
>t : Symbol(t, Decl(iterableWithNeverAsUnionMember.ts, 4, 41))

let [el2] = x; // ok
>el2 : Symbol(el2, Decl(iterableWithNeverAsUnionMember.ts, 5, 5))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 4, 11))

for (const elem of x) { // ok
>elem : Symbol(elem, Decl(iterableWithNeverAsUnionMember.ts, 7, 10))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 4, 11))

elem.toFixed();
>elem.toFixed : Symbol(Number.toFixed, Decl(lib.es5.d.ts, --, --))
>elem : Symbol(elem, Decl(iterableWithNeverAsUnionMember.ts, 7, 10))
>toFixed : Symbol(Number.toFixed, Decl(lib.es5.d.ts, --, --))
}

type Shape =
>Shape : Symbol(Shape, Decl(iterableWithNeverAsUnionMember.ts, 9, 1))

| { kind: "circle"; radius: number }
>kind : Symbol(kind, Decl(iterableWithNeverAsUnionMember.ts, 12, 5))
>radius : Symbol(radius, Decl(iterableWithNeverAsUnionMember.ts, 12, 21))

| { kind: "rectangle"; width: number; height: number };
>kind : Symbol(kind, Decl(iterableWithNeverAsUnionMember.ts, 13, 5))
>width : Symbol(width, Decl(iterableWithNeverAsUnionMember.ts, 13, 24))
>height : Symbol(height, Decl(iterableWithNeverAsUnionMember.ts, 13, 39))

type Circle = Shape & { kind: "circle" };
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))
>Shape : Symbol(Shape, Decl(iterableWithNeverAsUnionMember.ts, 9, 1))
>kind : Symbol(kind, Decl(iterableWithNeverAsUnionMember.ts, 15, 23))

function doStuffWithCircle(arg: Circle | [Circle, (newValue: Circle) => void]) {
>doStuffWithCircle : Symbol(doStuffWithCircle, Decl(iterableWithNeverAsUnionMember.ts, 15, 41))
>arg : Symbol(arg, Decl(iterableWithNeverAsUnionMember.ts, 17, 27))
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))
>newValue : Symbol(newValue, Decl(iterableWithNeverAsUnionMember.ts, 17, 51))
>Circle : Symbol(Circle, Decl(iterableWithNeverAsUnionMember.ts, 13, 57))

if (Array.isArray(arg)) {
>Array.isArray : Symbol(ArrayConstructor.isArray, Decl(lib.es5.d.ts, --, --))
>Array : Symbol(Array, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2015.core.d.ts, --, --), Decl(lib.es2015.iterable.d.ts, --, --), Decl(lib.es2015.symbol.wellknown.d.ts, --, --) ... and 4 more)
>isArray : Symbol(ArrayConstructor.isArray, Decl(lib.es5.d.ts, --, --))
>arg : Symbol(arg, Decl(iterableWithNeverAsUnionMember.ts, 17, 27))

let [value, setValue] = arg; // ok
>value : Symbol(value, Decl(iterableWithNeverAsUnionMember.ts, 19, 9))
>setValue : Symbol(setValue, Decl(iterableWithNeverAsUnionMember.ts, 19, 15))
>arg : Symbol(arg, Decl(iterableWithNeverAsUnionMember.ts, 17, 27))
}
}

function f1<T extends { a: "foo" } & { a: "bar" }>(x: T) {
>f1 : Symbol(f1, Decl(iterableWithNeverAsUnionMember.ts, 21, 1))
>T : Symbol(T, Decl(iterableWithNeverAsUnionMember.ts, 23, 12))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 23, 23))
>a : Symbol(a, Decl(iterableWithNeverAsUnionMember.ts, 23, 38))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 23, 51))
>T : Symbol(T, Decl(iterableWithNeverAsUnionMember.ts, 23, 12))

let [y] = x; // error
>y : Symbol(y, Decl(iterableWithNeverAsUnionMember.ts, 24, 7))
>x : Symbol(x, Decl(iterableWithNeverAsUnionMember.ts, 23, 51))
}

Loading