make location.reload() return never

[k-yle]

writing code after location.reload() is very likely a mistake, since the code will probably never run.

So this PR changes location.reload() to return never, akin to process.exit() in node

[github-actions]

Thanks for the PR!

This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged.

[saschanaz]

Thanks! LGTM.

[github-actions]

Merging because @saschanaz is a code-owner of all the changes - thanks!

[HolgerJeromin]

In my test this does not change compile behavior with code after that.
But no problem with it either.

[k-yle]

Hey @HolgerJeromin, it works for me, here's an example in the TS Playground which correctly errors with TS7027

[HolgerJeromin]

Interesting. My code uses the location object on window which breaks this error also in playground:

declare interface Location {
  reload(): never;
}
window.location.reload()
console.log("...")

[turansky]

What about iframes?

const frame = window[0]
frame.location.reload() // never

console.log("Is it really unreachable?")

[aerialist7]

@k-yle , self.location.reload() same as window.location.reload() breaks this error

[HolgerJeromin]

You can use the playground link above to test yourself...
iframe does not work either

[aerialist7]

And yes, seems that we can have executable code after iframes location reload.
So the PR looks weird

[HolgerJeromin]

And yes, seems that we can have executable code after iframes location reload.

Which is a good thing BTW, because an iframe reload does not break code flow in runtime of the top frame.
But this could result to false negatives which are not solvable by the developer (without many @ts-ignoreerror).

[saschanaz]

Oh yes, I did not think about the iframe case, I guess I'll have to revert this.

[saschanaz]

Reverting this in #1545 to prevent unexpected breakage. Feel free to file an issue to continue the discussion.