Merge pull request #13 from bmeck/master

add typescript definitions

index.d.ts

@@ -0,0 +1,32 @@
+// Type definitions for: hearing-aid
+/// <reference lib="dom">
+/// <reference types="node">
+export = hearing;
+
+// Browser
+declare function hearing(
+  what: EventTarget,
+  when: string,
+  how: EventListenerOrEventListenerObject): () => void;
+
+// Node
+declare function hearing(
+  what: import('events').EventEmitter,
+  when: string,
+  how: (...args: any) => any): () => void;
+
+// Ad-hoc
+declare function hearing(
+  what: Object & ({
+    addEventListener: Function,
+    removeEventListener?: Function
+  } | {
+    attachEvent: Function,
+    detachEvent?: Function
+  } | {
+    on: Function,
+    removeListener?: Function,
+    off?: Function
+  }),
+  when: string,
+  how: Function): () => void;

index.js

@@ -11,6 +11,13 @@ var ftw = typeof window !== 'undefined' ? window : {}
  * @param {Function} how Function to be executed.
  * @returns {Function}
  * @api public
+ *
+ * @example ```js
+  // listen for `stream` to 'end'
+  var stop = hearing(stream, 'end', callback);
+  // stop listening after 1 second
+  setTimeout(stop, 1000);
+  ```
  */
 module.exports = function hearing(what, when, how) {
   if ('addEventListener' in what) {

package.json

@@ -39,5 +39,6 @@
   },
   "dependencies": {
     "one-time": "0.0.4"
-  }
+  },
+  "types": "./index.d.ts"
 }