2.0.11

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartdelay",
   "private": false,
-  "version": "2.0.7",
+  "version": "2.0.11",
   "description": "timeouts for the async/await era, written in TypeScript",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -28,7 +28,7 @@
     "@gitzone/tsrun": "^1.2.8",
     "@gitzone/tstest": "^1.0.28",
     "@pushrocks/tapbundle": "^3.2.1",
-    "@types/node": "^14.0.5",
+    "@types/node": "^15.12.0",
     "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },

readme.md

@@ -0,0 +1,45 @@
+# @pushrocks/smartdelay
+timeouts for the async/await era, written in TypeScript
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdelay)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdelay)
+* [github.com (source mirror)](https://github.com/pushrocks/smartdelay)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartdelay/)
+
+## Status for master
+[![pipeline status](https://gitlab.com/pushrocks/smartdelay/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartdelay/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartdelay/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartdelay/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartdelay.svg)](https://www.npmjs.com/package/@pushrocks/smartdelay)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartdelay/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartdelay)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+```javascript
+import * as smartdelay from 'smartdelay';
+
+(async () => {
+  await smartdelay.delayFor(3000); // excution will halt here 3 seconds for this function scope BUT NOT BLOCK anything else
+  console.log('hi there');
+
+  // You can also go random
+  await smartdelay.delayForRandom(2000, 6000); // this will delay exection somewhere between 2 and 6 seconds.
+  console.log('Yay. You did not see me coming at this exact time');
+})();
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

ts/index.ts

@@ -2,41 +2,39 @@ import * as smartpromise from '@pushrocks/smartpromise';
 
 /**
  * delay something, works like setTimeout
- * @param timeInMillisecond
- * @param passOn
+ * @param timeInMillisecondArg
+ * @param passOnArg
  */
-export let delayFor = async <T>(timeInMillisecond: number, passOn?: T) => {
-  await new Promise((resolve, reject) => {
-    setTimeout(() => {
-      resolve();
-    }, timeInMillisecond);
-  });
-  return passOn;
+export let delayFor = async <T>(timeInMillisecondArg: number, passOnArg?: T, unrefedArg = false) => {
+  const timeout = new Timeout(timeInMillisecondArg, null, unrefedArg);
+  await timeout.promise;
+  return passOnArg;
 };
 
 /**
  * delay for a random time
  */
 export let delayForRandom = async <T>(
-  timeMinInMillisecond: number,
-  timeMaxInMillisecond: number,
-  passOn?: T
+  timeMinInMillisecondArg: number,
+  timeMaxInMillisecondArg: number,
+  passOnArg?: T,
+  unrefedArg = false
 ) => {
-  await new Promise((resolve, reject) => {
-    setTimeout(() => {
-      resolve();
-    }, Math.random() * (timeMaxInMillisecond - timeMinInMillisecond) + timeMinInMillisecond);
-  });
-  return passOn;
+  await delayFor(Math.random() * (timeMaxInMillisecondArg - timeMinInMillisecondArg) + timeMinInMillisecondArg, null, unrefedArg)
+  return passOnArg;
 };
 
 export class Timeout<T> {
   promise: Promise<T>;
   private _deferred: smartpromise.Deferred<T>;
-  private _timeout: any;
+  private _timeout;
   private _cancelled: boolean = false;
 
-  constructor(timeInMillisecondArg, passOn?: T) {
+  private timeoutInMillis: number;
+  private started: number;
+
+  constructor(timeInMillisecondArg, passOn?: T, unrefedArg = false) {
+    this.timeoutInMillis = timeInMillisecondArg;
     this._deferred = smartpromise.defer<T>();
     this.promise = this._deferred.promise;
     this._timeout = setTimeout(() => {
@@ -44,6 +42,10 @@ export class Timeout<T> {
         this._deferred.resolve(passOn);
       }
     }, timeInMillisecondArg);
+    this.started = Date.now();
+    if (unrefedArg) {
+      this.makeUnrefed();
+    }
   }
 
   /**
@@ -58,6 +60,11 @@ export class Timeout<T> {
    */
   public cancel() {
     this._cancelled = true;
-    this.makeUnrefed();
+    clearTimeout(this._timeout);
+  }
+  
+  public getTimeLeft() {
+    const result = this.started + this.timeoutInMillis - Date.now();
+    return result > 0 ? result : 0;
   }
 }