diff options
Diffstat (limited to 'mitt.d.ts')
| -rw-r--r-- | mitt.d.ts | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/mitt.d.ts b/mitt.d.ts new file mode 100644 index 0000000..41ea221 --- /dev/null +++ b/mitt.d.ts @@ -0,0 +1,46 @@ +declare var mitt: mitt.MittStatic; + +declare module "mitt" { + export = mitt; +} + +declare namespace mitt { + type Handler = (event?: any) => void; + + interface MittStatic { + new(all?: {[key: string]: Handler}): Emitter; + } + + interface Emitter { + /** + * Register an event handler for the given type. + * + * @param {string} type Type of event to listen for, or `"*"` for all events. + * @param {Handler} handler Function to call in response to the given event. + * + * @memberOf Mitt + */ + on(type: string, handler: Handler): void; + + /** + * Function to call in response to the given event + * + * @param {string} type Type of event to unregister `handler` from, or `"*"` + * @param {Handler} handler Handler function to remove. + * + * @memberOf Mitt + */ + off(type: string, handler: Handler): void; + + /** + * Invoke all handlers for the given type. + * If present, `"*"` handlers are invoked prior to type-matched handlers. + * + * @param {string} type The event type to invoke + * @param {any} [event] An event object, passed to each handler + * + * @memberOf Mitt + */ + emit(type: string, event?: any): void; + } +} |
