TypeScript-DOM-lib-generator icon indicating copy to clipboard operation
TypeScript-DOM-lib-generator copied to clipboard

feat: add type parameter to EventTarget

Open 43081j opened this issue 1 year ago • 4 comments

This introduces a type parameter to EventTarget such that the following is now possible:

interface CustomMap {
  'test-event': CustomEvent<{x: number; y: number}>;
}

declare const customTarget: EventTarget<CustomMap>;

customTarget.addEventListener('test-event', (event) => {
  // event is now `CustomEvent<{x: number; y: number}>`
  event.detail.x;
  event.detail.y;
});

Defaults to T = any to maintain existing behaviour otherwise.

Reviewer notes

i did two attempts at this:

  1. override the interface and just specify each of the signatures (this pr)
  2. update the emitter to have a special case for EventTarget where it will then emit event handlers

1 - overrides (this PR)

i don't like that i'm basically repeating the signatures of emitEventHandlers manually in the overrides JSON. though the result does seem to work well.

maybe there's a cleaner way to do this?

2 - update the emitter

we could just change emitEventHandlers to ultimately do this logic:

      if (hasEventListener || ehParentCount > 1) {
        mapName = `${i.name}EventMap`;
      } else if (ehParentCount === 1) {
        mapName = `${iNameToEhParents[i.name][0].name}EventMap`;
      } else if (i.name === "EventTarget") {
        mapName = "T";

which is then used to print the signatures.

i've tried this and it failed because it adds those signatures rather than replacing the existing ones.

any advice would be helpful of how to approach this

also if there's some fundamental reason this can never work, im of course happy to close the PR but would like to understand first

43081j avatar May 03 '24 22:05 43081j