Add CustomEvent to EventListener

[Chris Ewald (mkcode)]

Type definition for EventListener and EventListenerObject is overly narrow and does not allow for CustomEvent.

Submitting this PR on behalf of issue: microsoft/TypeScript#28357

MDN and WhatWG seem to specify that this is allowed:

• https://dom.spec.whatwg.org/#defining-event-interfaces
• https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#the_event_listener_callback

[github-actions]

Thanks for the PR!

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

[Chris Ewald (mkcode)]

Kagami Sascha Rosylight (@saschanaz) - Following up on your comment: microsoft/TypeScript#28357 (comment)

I believe that extending the EventMap interfaces would not solve the issue for generic EventTargets.

This way does, but may break other things.

[Kagami Sascha Rosylight (saschanaz)]

Event | CustomEvent is equivalent to CustomEvent, and thus this makes every unknown event interfaces as CustomEvents. IMO that's too aggressive, as:

1. Any "custom events" also can use the base Event instead of CustomEvent or any custom subclasses of Event
2. Any new event added in new versions of browsers will collide with the CustomEvent definition (Event as AnySubclassedEvent works but CustomEvent as AnySubclassedEvent does not)

I believe that extending the EventMap interfaces would not solve the issue for generic EventTargets.

You should still be able to add your own addEventListener signature in that case and follow the pattern of the existing types.

[Chris Ewald (mkcode)]

Yep. This is much more complicated than the DX that I want of just specifying the parameter type of the callback function:

object.addEventListener('my-event', (event: CustomEvent<CustomType>) => { event.detail }))

But, I think you are right that what I wrote is actually just a bad TypeScript pattern. The type definition belongs in the object definition using the methods you described, not in callback handlers.

Thank you. I appreciate your time and detailed response!