Support for multiple method signatures by Bashamega · Pull Request #2227 · microsoft/TypeScript-DOM-lib-generator

Bashamega · 2025-11-02T11:57:22Z

#2053

github-actions · 2025-11-02T11:57:34Z

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.

Bashamega · 2025-11-02T11:58:03Z

baselines/ts5.5/dom.generated.d.ts

    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/getError) */
    getError(): GLenum;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/getExtension) */
+    getExtension(name: string): any;


Any idea why this got moved up? @saschanaz

Because this PR is now merging signature while originally this was using additionalSignatures, which has ordering difference. But the different order doesn't seem to affect TS behavior, while I thought it would matter, or at least it did at some point (microsoft/TypeScript#1860 (comment)). Maybe that changed.

@jakebailey, any idea?

We could flip things around in the emitter.

saschanaz · 2025-11-02T14:07:56Z

baselines/ts5.5/dom.generated.d.ts

    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/getError) */
    getError(): GLenum;
    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/getExtension) */
+    getExtension(name: string): any;


Because this PR is now merging signature while originally this was using additionalSignatures, which has ordering difference. But the different order doesn't seem to affect TS behavior, while I thought it would matter, or at least it did at some point (microsoft/TypeScript#1860 (comment)). Maybe that changed.

@jakebailey, any idea?

src/build/emitter.ts

inputfiles/patches/webgl.kdl

saschanaz · 2025-11-02T14:37:37Z

inputfiles/patches/webgl.kdl

+  method getExtension {
+    signatures {
+      _ {
+        param extensionName type="\"ANGLE_instanced_arrays\""


BTW you can also do

Suggested change

param extensionName type="\"ANGLE_instanced_arrays\""

param extensionName type=#""ANGLE_instanced_arrays""#

Which one would you prefer @saschanaz?

src/build/emitter.ts

…cript-DOM-lib-generator into method-signature

saschanaz

Going to the right direction

src/build/patches.ts

src/build/emitter.ts

…b-generator into method-signature

saschanaz

LGTM, assuming @jakebailey is okay with the overload ordering.

Bashamega · 2025-11-03T08:26:43Z

I have fixed the ordering issue @saschanaz

saschanaz · 2025-11-03T08:27:52Z

I don't like the last change and canceling my approval. Let's ask Jake first?

Bashamega · 2025-11-03T08:28:56Z

Sure @saschanaz
I can revert it if you want

saschanaz · 2025-11-03T08:35:16Z

That will bring my approval back 👍

This reverts commit ae72c10.

Bashamega · 2025-11-03T08:51:28Z

I have reverted it @saschanaz

Bashamega · 2025-11-03T09:06:00Z

Hey @saschanaz
I wrote some unit tests, and all came back working. We can merge now, I think

saschanaz · 2025-11-03T09:43:14Z

Let's ask Jake first?

This.

saschanaz · 2025-11-03T09:43:56Z

unittests/files/webgl.ts

+// TypeScript should infer: ANGLE_instanced_arrays | null
+assertType<ANGLE_instanced_arrays | null>(ext_ANGLE_instanced_arrays);
+
+const ext_EXT_blend_minmax = gl.getExtension("EXT_blend_minmax");


Meh, one is enough, we don't have to cover every overload.

saschanaz · 2025-11-03T09:44:30Z

unittests/files/webgl.ts

+
+const ext_ANGLE_instanced_arrays = gl.getExtension("ANGLE_instanced_arrays");
+// TypeScript should infer: ANGLE_instanced_arrays | null
+assertType<ANGLE_instanced_arrays | null>(ext_ANGLE_instanced_arrays);


This won't work if ext_ is any

Can you clarify?
It is never any

The intention of the test is to check it's not any. But if it becomes any this still won't fail.

Try giving "ANGLE_illegal" instead for getExtension.

Yeah, this isn't a correct way to test this, unfortunately. If this is any, it's legal to cast to anything.

Removed multiple unused WebGL extension assertions.

src/build/patches.ts

Bashamega · 2025-11-03T10:14:35Z

I have added more types @saschanaz

saschanaz · 2025-11-03T10:29:27Z

Cool, thanks!

jakebailey · 2025-11-03T15:37:47Z

Isn't it critical that the overloads are ordered most specific to least specific?

Bashamega · 2025-11-03T15:58:08Z

Isn't it critical that the overloads are ordered most specific to least specific?

I think that changed since I wrote tests, and they worked

jakebailey · 2025-11-03T17:18:28Z

I would be very surprised if so, given we are supposed to walk top to bottom.

How much work is it to avoid this? Is it challenging? (I am not asking for it to be changed yet)

Bashamega · 2025-11-03T17:21:14Z

I tried to avoid it but @saschanaz didn't like the proposed solution
This was the solution ae72c10

Another solution is to just use overrideSignature like the original

saschanaz · 2025-11-04T01:52:44Z

Isn't it critical that the overloads are ordered most specific to least specific?

I thought so but it works nonetheless. I thought you would know why...

jakebailey · 2025-11-06T22:24:21Z

Utterly weird

jakebailey · 2025-11-06T22:24:32Z

Anyway I guess this PR is fine, but needs a main merge

Support for multiple method signatures

98639de

Bashamega commented Nov 2, 2025

View reviewed changes

Bashamega and others added 2 commits November 2, 2025 13:58

Lint

9cd72de

Delete hey

ee0b5ce

saschanaz reviewed Nov 2, 2025

View reviewed changes

Bashamega added 2 commits November 2, 2025 17:34

Update format

b12f22b

Merge branch 'method-signature' of https://github.com/Bashamega/TypeS…

85d2353

…cript-DOM-lib-generator into method-signature

saschanaz reviewed Nov 2, 2025

View reviewed changes

src/build/patches.ts Outdated Show resolved Hide resolved

src/build/patches.ts Show resolved Hide resolved

src/build/patches.ts Outdated Show resolved Hide resolved

src/build/emitter.ts Outdated Show resolved Hide resolved

Bashamega added 5 commits November 2, 2025 17:47

-

8588188

-

19a7eeb

Merge branch 'main' of https://github.com/Bashamega/TypeScript-DOM-li…

b967260

…b-generator into method-signature

Use override type

d7a25a6

-

b61dbde

saschanaz reviewed Nov 3, 2025

View reviewed changes

Fix order

ae72c10

-

77990a6

Bashamega added 3 commits November 3, 2025 10:43

Revert "Fix order"

3e09c30

This reverts commit ae72c10.

-

ca7b3df

generate

e84e44c

Unit tests

be628db

saschanaz reviewed Nov 3, 2025

View reviewed changes

Clean up unused WebGL extension checks

e434e83

Removed multiple unused WebGL extension assertions.

saschanaz reviewed Nov 3, 2025

View reviewed changes

src/build/patches.ts Outdated Show resolved Hide resolved

Types

aea1bf4

Merge branch 'main' into method-signature

b1b97fc

Bashamega closed this Nov 6, 2025

Bashamega deleted the method-signature branch November 6, 2025 03:49

Bashamega restored the method-signature branch November 6, 2025 03:50

Bashamega reopened this Nov 6, 2025

Bashamega added 2 commits November 7, 2025 06:33

merge

7517bb4

Remove duplicate signature

c4692a3

jakebailey approved these changes Nov 7, 2025

View reviewed changes

jakebailey merged commit f915ac0 into microsoft:main Nov 7, 2025
7 checks passed

Bashamega deleted the method-signature branch November 7, 2025 06:13

	param extensionName type="\"ANGLE_instanced_arrays\""
	param extensionName type=#""ANGLE_instanced_arrays""#

Conversation

Bashamega commented Nov 2, 2025

Uh oh!

github-actions bot commented Nov 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

saschanaz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

saschanaz left a comment

Choose a reason for hiding this comment

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

saschanaz commented Nov 3, 2025

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

saschanaz commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

saschanaz commented Nov 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

saschanaz Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

saschanaz commented Nov 3, 2025

Uh oh!

jakebailey commented Nov 3, 2025

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

jakebailey commented Nov 3, 2025

Uh oh!

Bashamega commented Nov 3, 2025

Uh oh!

saschanaz commented Nov 4, 2025

Uh oh!

jakebailey commented Nov 6, 2025

Uh oh!

jakebailey commented Nov 6, 2025

Uh oh!

saschanaz commented Nov 3, 2025 •

edited

Loading

saschanaz Nov 3, 2025 •

edited

Loading