add typescript support

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+/lib

README.md

@@ -1,14 +1,13 @@
-windowpubsub
-===
+# windowpubsub
 
 Simple and lightweight Pub/Sub library using Window event listener and storage event with zero dependencies.
 
 This enable applications to subscribe to events across different windows or tabs.
 Some use cases are for shopping carts updates or theme switching.
 
 #### Subscribing
-`subscribe(topic, callbackFunction);`
 
+`subscribe(topic, callbackFunction);`
 
 ```
 import localpubsub from 'localpubsub';
@@ -20,13 +19,15 @@ localpubsub.subscribe('my topic', displayMessage);
 ```
 
 #### Publishing
+
 `publish(topic, message);`
 
 ```
 localpubsub.publish('my topic', 'Hello');
 ```
 
 #### Unsubscribe
+
 `unsubscribe(topic);`
 
 ```

package.json

@@ -1,10 +1,12 @@
 {
   "name": "windowpubsub",
-  "version": "0.0.2",
-  "description": "",
-  "main": "index.js",
+  "version": "0.1.0",
+  "description": "Simple and lightweight Pub/Sub library using Window event listener and storage event with zero dependencies.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
@@ -21,5 +23,8 @@
   "bugs": {
     "url": "https://github.com/griffithtp/widowpubsub/issues"
   },
-  "homepage": "https://github.com/griffithtp/windowpubsub#readme"
+  "homepage": "https://github.com/griffithtp/windowpubsub#readme",
+  "devDependencies": {
+    "typescript": "^3.9.2"
+  }
 }

index.js → src/index.ts

@@ -1,6 +1,7 @@
-let topics = {};
+let topics: Record<string, unknown> = {};
+// type Record<K extends string | number | symbol, T> = { [P in K]: T; }
 
-function subscribe(topic, listener) {
+function subscribe(topic: string, listener: ({}) => {}) {
   if (!topics.hasOwnProperty(topic)) {
     topics[topic] = listener;
   }
@@ -21,27 +22,27 @@ function subscribe(topic, listener) {
   };
 }
 
-function processCustomEvent(topic, cb, result) {
+function processCustomEvent(topic: string, cb: ({}) => {}, result: any) {
   if (topic === result.type) {
     return cb({ topic, value: result.detail, eventObject: result });
   }
 }
 
-function processStorage(topic, cb, result) {
+function processStorage(topic: string, cb: ({}) => {}, result: any) {
   if (topic === result.key) {
     return cb({ topic, value: result.newValue, eventObject: result });
   }
 }
 
-function publish(eventName, eventValue) {
+function publish(eventName: string, eventValue: any) {
   if (topics[eventName]) {
     window.localStorage.setItem(eventName, eventValue);
     const customEvent = new CustomEvent(eventName, { detail: eventValue });
     window.dispatchEvent(customEvent);
   }
 }
 
-function unsubscribe(subscribeKey) {
+function unsubscribe(subscribeKey: string) {
   window.localStorage.removeItem(subscribeKey);
   delete topics[subscribeKey];
 }

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./lib",
+    "strict": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
+}