2.0.13

.gitlab-ci.yml

@@ -19,23 +19,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - 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:
+    - docker
+  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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +63,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +74,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +94,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartdelay",
   "private": false,
-  "version": "2.0.8",
+  "version": "2.0.13",
   "description": "timeouts for the async/await era, written in TypeScript",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild && tsbundle npm)"
+    "build": "(tsbuild --web && tsbundle npm)"
   },
   "repository": {
     "type": "git",
@@ -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"
   },
@@ -43,5 +43,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,13 +8,20 @@ timeouts for the async/await era, written in TypeScript
 * [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)
+Status Category | Status Badge
-[![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)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartdelay/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartdelay/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartdelay)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+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
 

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,41 +2,47 @@ import * as smartpromise from '@pushrocks/smartpromise';
 
 /**
  * delay something, works like setTimeout
- * @param timeInMillisecond
+ * @param timeInMillisecondArg
- * @param passOn
+ * @param passOnArg
  */
-export let delayFor = async <T>(timeInMillisecond: number, passOn?: T) => {
+export let delayFor = async <T>(
-  await new Promise((resolve, reject) => {
+  timeInMillisecondArg: number,
-    setTimeout(() => {
+  passOnArg?: T,
-      resolve();
+  unrefedArg = false
-    }, timeInMillisecond);
+) => {
-  });
+  const timeout = new Timeout(timeInMillisecondArg, null, unrefedArg);
-  return passOn;
+  await timeout.promise;
+  return passOnArg;
 };
 
 /**
  * delay for a random time
  */
 export let delayForRandom = async <T>(
-  timeMinInMillisecond: number,
+  timeMinInMillisecondArg: number,
-  timeMaxInMillisecond: number,
+  timeMaxInMillisecondArg: number,
-  passOn?: T
+  passOnArg?: T,
+  unrefedArg = false
 ) => {
-  await new Promise((resolve, reject) => {
+  await delayFor(
-    setTimeout(() => {
+    Math.random() * (timeMaxInMillisecondArg - timeMinInMillisecondArg) + timeMinInMillisecondArg,
-      resolve();
+    null,
-    }, Math.random() * (timeMaxInMillisecond - timeMinInMillisecond) + timeMinInMillisecond);
+    unrefedArg
-  });
+  );
-  return passOn;
+  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 +50,10 @@ export class Timeout<T> {
         this._deferred.resolve(passOn);
       }
     }, timeInMillisecondArg);
+    this.started = Date.now();
+    if (unrefedArg) {
+      this.makeUnrefed();
+    }
   }
 
   /**
@@ -58,6 +68,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;
   }
 }