add typescript typings

Author: dartess

package.json

@@ -3,9 +3,10 @@
   "version": "1.1.8",
   "description": "React timer hook is a custom react hook built to handle timers(countdown), stopwatch and time logic/state in your react component.",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build:dev": "webpack --config webpack.dev.js && webpack-dev-server --open --config webpack.dev.js",
-    "build:prod": "rm -rf ./dist && webpack --config webpack.prod.js"
+    "build:prod": "rm -rf ./dist && webpack --config webpack.prod.js && cpy src/index.d.ts dist/index.d.ts"
   },
   "repository": {
     "type": "git",
@@ -40,6 +41,7 @@
     "babel-preset-react": "^6.24.1",
     "babel-preset-stage-1": "^6.24.1",
     "copy-webpack-plugin": "^4.6.0",
+    "cpy-cli": "^3.0.0",
     "react": "^16.8.0",
     "react-dom": "16.8.0",
     "webpack": "^4.24.0",

src/index.d.ts

@@ -0,0 +1,46 @@
+interface TimerSettings {
+    expiryTimestamp: number;
+    onExpire?: () => void;
+}
+
+interface TimerResult {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+    start: () => void;
+    pause: () => void;
+    resume: () => void;
+    restart: (newExpiryTimestamp: number) => void;
+}
+
+export function useTimer(settings: TimerSettings): TimerResult
+
+interface StopwatchSettings {
+    autoStart?: boolean;
+}
+
+interface StopwatchResult {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    days: number;
+    start: () => void;
+    pause: () => void;
+    reset: () => void;
+}
+
+export function useStopwatch(settings?: StopwatchSettings): StopwatchResult
+
+interface TimeSettings {
+    format?: '12-hour';
+}
+
+interface TimeResult {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    ampm: '' | 'pm' | 'am';
+}
+
+export function useTime(settings?: TimeSettings): TimeResult