@slime/stopwatch - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "@slime/stopwatch",
-  "version": "1.0.1",
-  "description": "a class for handling elapsed time in ms",
+  "version": "1.0.2",
+  "description": "a class for handling and printing elapsed time in ms",
   "main": "StopWatch.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -22,7 +22,23 @@ # StopWatch
 
-API to query number of ms elapsed and display time elapsed as minutes/seconds/ms string:
+getters API to query number of ms elapsed and display time elapsed as minutes/seconds/ms string:
 
 ```
-stopWatch.getTimeElapsedInMs(); // returns number of time elapsed in ms
-stopWatch.getTimeElapsedInStopWatchFormatString(); // returns mins/secs/ms in 00:00:00 format
+stopWatch.getTimeElapsedInMs; // returns number of time elapsed in ms
+stopWatch.getTimeElapsedInStopWatchFormatString; // returns mins/secs/ms in 00:00:00 format
 ```
+
+## demo usage
+start timer and show time elapsed after 1.5 seconds
+```
+const StopWatch = require("@slime/stopwatch"); 
+let stopWatch = new StopWatch(); 
+console.log(stopWatch.getTimeElapsedInMs);
+console.log(stopWatch.getTimeElapsedInStopWatchFormatString); 
+stopWatch.startTimer();
+setTimeout(()=>{
+    stopWatch.stopTimer();
+    console.log(stopWatch.getTimeElapsedInMs);
+    console.log(stopWatch.getTimeElapsedInStopWatchFormatString); 
+}, 1500); 
+```
+

No alert changes

Improved metrics

Total package byte prevSize

5593

increased by9.26%

Number of lines in readme file

44

increased by57.14%

No dependency changes