Merge pull request #160 from dubalol/typescript-declaration-file

Types declaration file and package.json update

Author: rkwn

package/index.d.ts

@@ -0,0 +1,39 @@
+// Type definitions for reactime v3.1
+// Project: <https://github.com/open-source-labs/reactime>
+// Definitions by: Abaas Khorrami <https://github.com/dubalol>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/**
+ * The 'reactime' module has one export:
+ * --> the async @function returned from linkFiber.js
+ * @param {container} --> the div element corresponding to your root container
+ * @returns {void} --> no return value
+ * 
+ * Reactime contributors:
+ * Abaas Khorrami
+ * Andy Wond
+ * Bryan Lee
+ * Chris Flannery
+ * David Chai
+ * Ergi Shehu
+ * Joshua Howard
+ * Josh Kim
+ * Prasanna Malla
+ * Rajeeb Banstola
+ * Rocky Lin
+ * Ruth Anam
+ * Ryan Dang
+ * Sierra Swaby
+ * Yujin Kang
+ * 
+ * 
+ * NOTE: TypeScript support is in beta and still experimental.  
+ * 
+ */
+
+declare module "reactime" {
+  function linkFiber(
+    container: HTMLElement,
+  ): void;
+  export = linkFiber;
+}

package/package.json

@@ -10,6 +10,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\""
   },
+  "types": "./index.d.ts",
   "peerDependencies": {
     "react": "~16.0.0",
     "react-dom": "~16.0.0"