aboutsummaryrefslogtreecommitdiff
path: root/mitt.d.ts
diff options
context:
space:
mode:
authorSeverin <[email protected]>2017-02-25 22:24:28 +0100
committerJason Miller <[email protected]>2017-02-25 16:24:28 -0500
commitd63b350e6de3360d05ed6360cfaf101017237a73 (patch)
tree4ea94af3c01e2c444a00442e22832bd3532faa3c /mitt.d.ts
parente428f3a171a286ca136f6aa08ac84ea4a892282e (diff)
Typescript definitions (#25)
* Added type definitions * Handler only has exactly one or no argument * Moved type defs to root folder
Diffstat (limited to 'mitt.d.ts')
-rw-r--r--mitt.d.ts46
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;
+ }
+}