timer-hook - npm Package Compare versions

Comparing version 1.0.9 to 1.0.10

package.json

 {
   "name": "timer-hook",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "An easy to use timer hook for React",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

 # timer-hook
 
 Demo: https://codesandbox.io/s/timer-hook-example-ze88r
+
+## Usage
+
+```javascript
+import React from 'react';
+import { useTimer } from 'timer-hook';
+
+const App = () => {
+  const { time, start, pause, reset, isRunning } = useTimer();
+
+  return (
+    <>
+      <div>Time: {time}</div>
+      <div>
+        <button onClick={start}>{isRunning ? 'Start' : 'Running'}</button>
+        <button onClick={pause}>Pause</button>
+        <button onClick={reset}>Reset</button>
+      </div>
+    </>
+  );
+};
+```
+
+## Configuration
+
+All configurations are optional
+
+| Property    | Type     | Default value | Description                                                                            |
+| ----------- | -------- | ------------- | -------------------------------------------------------------------------------------- |
+| endTime     | number   | null          | end time for the timer                                                                 |
+| initialTime | number   | 0             | starting value for the timer                                                           |
+| interval    | number   | 1000          | the interval between each tick in milliseconds                                         |
+| onEnd       | function |               | callback function to run when timer is over                                            |
+| step        | number   | 1             | the value to change by each tick                                                       |
+| type        | string   | "INCREMENT"   | "INCREMENT" or "DECREMENT"                                                             |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10271

increased by17.72%

Number of lines in readme file

38

increased by850%

No dependency changes