Typescript support (#8)

Co-authored-by: Achmad Kurnianto <[email protected]>
Co-authored-by: Renée Kooi <[email protected]>

Author: achmadk

package.json

@@ -2,22 +2,23 @@
   "name": "react-bus",
   "description": "A global event emitter for react.",
   "version": "2.0.1",
+  "typings": "types/index.d.ts",
   "author": "Renée Kooi <[email protected]>",
   "bugs": {
     "url": "https://github.com/goto-bus-stop/react-bus/issues"
   },
   "dependencies": {
-    "mitt": "^1.1.3"
+    "mitt": "^2.1.0"
   },
   "peerDependencies": {
-    "react": ">= 16.8.0"
+    "react": ">=17.0.0"
   },
   "devDependencies": {
+    "@rollup/plugin-buble": "^0.21.3",
     "react": "^17.0.0",
     "react-test-renderer": "^17.0.0",
-    "rollup": "^2.0.1",
-    "rollup-plugin-buble": "^0.19.8",
-    "tape": "^5.0.1"
+    "rollup": "^2.38.0",
+    "tape": "^5.1.1"
   },
   "homepage": "https://github.com/goto-bus-stop/react-bus#readme",
   "keywords": [

rollup.config.js

@@ -1,4 +1,4 @@
-import buble from 'rollup-plugin-buble'
+import buble from '@rollup/plugin-buble'
 
 const meta = require('./package.json')
 

types/index.d.ts

@@ -0,0 +1,29 @@
+import React, { FC, ReactNode } from 'react';
+import { Emitter, EventType, Handler } from 'mitt';
+export declare const BusContext: React.Context<Emitter | null>;
+/**
+ * Return the event emitter.
+ *
+ * @export
+ * @return {*}
+ */
+export declare function useBus(): Emitter;
+/**
+ * Attach an event listener to the bus while this component is mounted. Adds the listener after mount, and removes it before unmount.
+ *
+ * @export
+ * @param {string} name
+ * @param {Handler} fn
+ */
+export declare function useListener<T = any>(name: EventType, fn: Handler<T>): void;
+export interface ProviderProps {
+    children?: ReactNode;
+}
+/**
+ * Create an event emitter that will be available to all deeply nested child elements using the useBus() hook.
+ *
+ * @export
+ * @param {ProviderProps} { children }
+ * @return {*}
+ */
+export declare const Provider: FC<ProviderProps>;