2.0.12

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -19,22 +19,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +63,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +74,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,6 +94,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,45 +0,0 @@
-# @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
-[![build status](https://gitlab.com/pushrocks/smartdelay/badges/master/build.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: [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)

npmextra.json

@@ -4,6 +4,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartdelay",
   "private": false,
-  "version": "2.0.5",
+  "version": "2.0.12",
   "description": "timeouts for the async/await era, written in TypeScript",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild && tsbundle npm)"
   },
   "repository": {
     "type": "git",
@@ -23,21 +23,28 @@
     "@pushrocks/smartpromise": "^3.0.6"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbundle": "^1.0.69",
     "@gitzone/tsrun": "^1.2.8",
     "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.12.5"
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^15.12.0",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -0,0 +1,52 @@
+# @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
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartdelay/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartdelay/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartdelay)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartdelay)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartdelay)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartdelay)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartdelay)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## 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)

test/test.ts

@@ -2,7 +2,7 @@ import { expect, tap } from '@pushrocks/tapbundle';
 
 import * as smartdelay from '../ts/index';
 
-tap.test('.delayFor should delay async', async tools => {
+tap.test('.delayFor should delay async', async (tools) => {
   tools.timeout(5000);
   let timePassed = false;
   setTimeout(() => {
@@ -14,7 +14,7 @@ tap.test('.delayFor should delay async', async tools => {
   });
 });
 
-tap.test('.delayForRandom should delay async for a random time period', async tools => {
+tap.test('.delayForRandom should delay async for a random time period', async (tools) => {
   let timePassedBefore = false;
   let timePassedAfter = false;
   setTimeout(() => {
@@ -28,14 +28,14 @@ tap.test('.delayForRandom should delay async for a random time period', async to
   expect(timePassedAfter).to.be.false;
 });
 
-tap.test('.delayFor should pass on a type', async tools => {
+tap.test('.delayFor should pass on a type', async (tools) => {
   tools.timeout(5000);
   let timePassed = false;
   setTimeout(() => {
     timePassed = true;
   }, 2000);
   let hey = 'heyThere';
-  await smartdelay.delayFor<string>(3000, hey).then(async stringArg => {
+  await smartdelay.delayFor<string>(3000, hey).then(async (stringArg) => {
     expect(stringArg).equal('heyThere');
   });
 });
@@ -45,7 +45,7 @@ tap.test('smartdelay.Timeout', async () => {
   await timeout.promise;
 });
 
-tap.test('smartdelay.Timeout should cancel', async tools => {
+tap.test('smartdelay.Timeout should cancel', async (tools) => {
   let timeout = new smartdelay.Timeout(60000);
   timeout.cancel();
 });

ts/index.ts

@@ -2,40 +2,47 @@ 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(() => {
@@ -43,14 +50,29 @@ export class Timeout<T> {
         this._deferred.resolve(passOn);
       }
     }, timeInMillisecondArg);
+    this.started = Date.now();
+    if (unrefedArg) {
+      this.makeUnrefed();
+    }
   }
 
-  makeUnrefed() {
+  /**
+   * unreffing a timeout causes the node process to not wait for completion before exit
+   */
+  public makeUnrefed() {
     this._timeout.unref();
   }
 
-  cancel() {
+  /**
+   * cancels the timer
+   */
+  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;
   }
 }