[Feat] Use type-safe EventEmitter interface #402
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This replaces the
SharderEvents
enum with an object type that maps event names to listener function signatures. In combination with theTypedEventEmitter
interface from@pizzafox/util
this means TypeScript users get automatic type-checking of their event listeners, and the library gets safe calls toemit
.In fact, implementing this revealed 2 non-compliant
ShardingManager#emit
usages:Kurasuta/src/IPC/MasterIPC.ts
Lines 62 to 66 in 16a2cfb
Kurasuta/src/IPC/MasterIPC.ts
Lines 68 to 72 in 16a2cfb
Adding the dependency will slightly increase bundle size, even though it's just used at build-time for TypeScript users. The official recommendation is to list it in the
dependencies
field ofpackage.json
.In its current state this PR is a breaking change since
SharderEvents
is no longer an enum. This could easily be changed back to anenum
and rename the new type to something likeSharderEventListeners
.