Update type definitions

[gfmio]

This PR adds a new set of type definitions to this library, as outlined in issue #217.

Right now, if the type parameter is a map of events and parameter array types, the parameters themselves don't get human-readable names. If the event map type instead supported using entire function annotations, the parameter names could be retained which makes using the library easier.

Before the changes in this PR, you could only do the following:

With the changes in this PR, you could do this:

Additionally, the PR adds an optional type parameter for the context object.

[gfmio]

@lpinca, when you have time, can you please take a look at this PR?

[lpinca]

I'm not qualified to review this PR as I don't use TypeScript.

cc: @delta62

[lpinca]

@gfmio is this a breaking change or can it cause issues if released as a patch release?

[gfmio]

@gfmio is this a breaking change or can it cause issues if released as a patch release?

No, this won't break anything, so it can be released as a patch.

The ListenerFn type is now unused, but I didn't precisely because it's I didn't want to break the API surface.

[lpinca]

Ok. I'll merge it then.

[lpinca]

Thank you.

[gfmio]

Thanks a lot, @lpinca!

[tjenkinson]

Haven’t looked in detail yet but FYI looks like this breaks hlsjs. See video-dev/hls.js#2718

[teazean]

Haven’t looked in detail yet but FYI looks like this breaks hlsjs. See video-dev/hls.js#2718

+1

[lpinca]

Can you provide a backward compatible patch? Otherwise I will revert it.

[lpinca]

It seems the issue with hls.js has been addressed in video-dev/hls.js@48db1a5.

[gfmio]

@lpinca Having a look now

[gfmio]

@tjenkinson @teazean @lpinca I've reproduced the error. The typings on the default export are correct, but not on the named export.

I will file a new PR to patch this. Thanks for reporting.

[tjenkinson]

Great thanks!

[gfmio]

@tjenkinson Can you verify that 4.0.3 fixes all issues for you?

[tjenkinson]

@gfmio 4.0.3 works fine again without needing extends EventEmitter<any> thanks!

[teazean]

thanks, 4.0.3 works fine.