Last active
March 19, 2021 07:25
-
-
Save ericwooley/6c00b61dee8ef7f61d73c4737f115faf to your computer and use it in GitHub Desktop.
How to make eventemitter3 typesafe
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import EventEMitter3 from 'eventemitter3' | |
interface EmitterEvent<Type extends string> extends Object { | |
type: Type; | |
} | |
interface AEvent extends EmitterEvent<'a'>{ | |
aOnly: true | |
} | |
interface BEvent extends EmitterEvent<'b'>{ | |
bOnly: true | |
} | |
type EmitterEvents = | |
| AEvent | |
| BEvent | |
class Emitter extends EventEMitter3<EmitterEvents['type']> { | |
on<Type extends EmitterEvents['type']>(name: Type, callback: (evt: Extract<EmitterEvents, {type: Type}>) => void) { | |
return super.on(name, callback) | |
} | |
emit<Type extends EmitterEvents['type']>(name: Type, evt: Omit<Extract<EmitterEvents, {type: Type}>, 'type'>) { | |
return super.emit(name, evt) | |
} | |
} | |
const em = new Emitter() | |
em.on('a', (evt) => { | |
evt.aOnly | |
// @ts-expect-error | |
evt.bOnly | |
}) | |
em.on('b', (evt) => { | |
evt.bOnly | |
// @ts-expect-error | |
evt.aOnly | |
}) | |
// @ts-expect-error | |
em.on('c', (evt) => { | |
// c doesn't exist | |
}) | |
em.emit('a', {aOnly: true}) | |
// @ts-expect-error | |
em.emit('b', {aOnly: true}) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment