2.0.7

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
+.nogit/
-docs/
+
+# artifacts
 coverage/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,59 +1,127 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
+  - security
-- release
+  - test
-- trigger
+  - release
-- pages
+  - metadata
 
-testLEGACY:
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+audit:
+  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
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test legacy
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
-  allow_failure: true
+    - priv
 
-testLTS:
+testBuild:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
-  tags:
+    - npmci node install stable
-    - docker
+    - npmci npm install
-    
+    - npmci command npm run build
-testSTABLE:
+  coverage: /\d+.?\d+?\%\s*coverage/
-  stage: test
-  script:
-    - npmci test stable
   tags:
+    - lossless
     - docker
+    - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  stage: metadata
-  stage: pages
   script:
-    - npmci command npmpage --publish gitlab
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
       - public
+  allow_failure: true

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,33 +0,0 @@
-# smartdelay
-timeouts for the async/await era, written in TypeScript
-
-## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartdelay)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartdelay)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartdelay)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](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/smartdelay.svg)](https://www.npmjs.com/package/smartdelay)
-[![Dependency Status](https://david-dm.org/pushrocks/smartdelay.svg)](https://david-dm.org/pushrocks/smartdelay)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdelay/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdelay/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdelay/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartdelay)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## 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()
-})()
-```
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,2 +0,0 @@
-import 'typings-global';
-export declare let delayFor: <T>(timeInMillisecond: number, passOn?: T) => Promise<T>;

dist/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-require("typings-global");
-exports.delayFor = (timeInMillisecond, passOn) => __awaiter(this, void 0, void 0, function* () {
-    yield new Promise((resolve, reject) => {
-        setTimeout(() => {
-            resolve();
-        }, timeInMillisecond);
-    });
-    return passOn;
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSwwQkFBdUI7QUFFWixRQUFBLFFBQVEsR0FBRyxDQUFVLGlCQUF5QixFQUFFLE1BQVU7SUFDakUsTUFBTSxJQUFJLE9BQU8sQ0FBQyxDQUFDLE9BQU8sRUFBRSxNQUFNO1FBQzlCLFVBQVUsQ0FDTjtZQUNJLE9BQU8sRUFBRSxDQUFBO1FBQ2IsQ0FBQyxFQUNELGlCQUFpQixDQUNwQixDQUFBO0lBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDRixNQUFNLENBQUMsTUFBTSxDQUFBO0FBQ2pCLENBQUMsQ0FBQSxDQUFBIn0=

npmextra.json

@@ -0,0 +1,17 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartdelay",
+      "shortDescription": "timeouts for the async/await era, written in TypeScript",
+      "npmPackagename": "@pushrocks/smartdelay",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "smartdelay",
+  "name": "@pushrocks/smartdelay",
-  "version": "1.0.1",
+  "private": false,
+  "version": "2.0.7",
   "description": "timeouts for the async/await era, written in TypeScript",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild && tsbundle npm)"
   },
   "repository": {
     "type": "git",
@@ -18,11 +20,28 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdelay#README",
   "dependencies": {
-    "typings-global": "^1.0.14"
+    "@pushrocks/smartpromise": "^3.0.6"
   },
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "@gitzone/tsbuild": "^2.1.24",
-    "should": "^11.1.2",
+    "@gitzone/tsbundle": "^1.0.69",
-    "typings-test": "^1.0.3"
+    "@gitzone/tsrun": "^1.2.8",
-  }
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.5",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,30 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const smartdelay = require("../dist/index");
-describe('smartdelay', function () {
-    it('.delayFor should delay async', function (done) {
-        this.timeout(5000);
-        let timePassed = false;
-        setTimeout(() => {
-            timePassed = true;
-        }, 2000);
-        smartdelay.delayFor(3000).then(() => {
-            should(timePassed).be.true();
-            done();
-        });
-    });
-    it('.delayFor should pass on a type', function (done) {
-        this.timeout(5000);
-        let timePassed = false;
-        setTimeout(() => {
-            timePassed = true;
-        }, 2000);
-        let hey = 'heyThere';
-        smartdelay.delayFor(3000, hey).then((stringArg) => {
-            should(stringArg).equal('heyThere');
-            done();
-        });
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQixpQ0FBZ0M7QUFFaEMsNENBQTJDO0FBRTNDLFFBQVEsQ0FBQyxZQUFZLEVBQUU7SUFDbkIsRUFBRSxDQUFDLDhCQUE4QixFQUFFLFVBQVMsSUFBSTtRQUM1QyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFBO1FBQ2xCLElBQUksVUFBVSxHQUFHLEtBQUssQ0FBQTtRQUN0QixVQUFVLENBQUM7WUFDUCxVQUFVLEdBQUcsSUFBSSxDQUFBO1FBQ3JCLENBQUMsRUFBQyxJQUFJLENBQUMsQ0FBQTtRQUNQLFVBQVUsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDO1lBQzNCLE1BQU0sQ0FBQyxVQUFVLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxFQUFFLENBQUE7WUFDNUIsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLGlDQUFpQyxFQUFFLFVBQVMsSUFBSTtRQUMvQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFBO1FBQ2xCLElBQUksVUFBVSxHQUFHLEtBQUssQ0FBQTtRQUN0QixVQUFVLENBQUM7WUFDUCxVQUFVLEdBQUcsSUFBSSxDQUFBO1FBQ3JCLENBQUMsRUFBQyxJQUFJLENBQUMsQ0FBQTtRQUNQLElBQUksR0FBRyxHQUFHLFVBQVUsQ0FBQTtRQUNwQixVQUFVLENBQUMsUUFBUSxDQUFTLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxTQUFTO1lBQ2xELE1BQU0sQ0FBQyxTQUFTLENBQUMsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLENBQUE7WUFDbkMsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.ts

@@ -1,31 +1,53 @@
-import 'typings-test'
+import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as should from 'should'
+import * as smartdelay from '../ts/index';
 
-import * as smartdelay from '../dist/index'
+tap.test('.delayFor should delay async', async tools => {
-
+  tools.timeout(5000);
-describe('smartdelay', function () {
+  let timePassed = false;
-    it('.delayFor should delay async', function(done) {
-        this.timeout(5000)
-        let timePassed = false
   setTimeout(() => {
-            timePassed = true
+    timePassed = true;
-        },2000)
+  }, 2000);
-        smartdelay.delayFor(3000).then(() => {
+  await smartdelay.delayFor(3000).then(async () => {
-            should(timePassed).be.true()
+    // tslint:disable-next-line:no-unused-expression
-            done()
+    expect(timePassed).to.be.true;
-        })
+  });
-    })
+});
-    it('.delayFor should pass on a type', function(done) {
+
-        this.timeout(5000)
+tap.test('.delayForRandom should delay async for a random time period', async tools => {
-        let timePassed = false
+  let timePassedBefore = false;
+  let timePassedAfter = false;
   setTimeout(() => {
-            timePassed = true
+    timePassedBefore = true;
-        },2000)
+  }, 3000);
-        let hey = 'heyThere'
+  setTimeout(() => {
-        smartdelay.delayFor<string>(3000, hey).then((stringArg) => {
+    timePassedAfter = true;
-            should(stringArg).equal('heyThere')
+  }, 5000);
-            done()
+  await smartdelay.delayForRandom(3000, 4900);
-        })
+  expect(timePassedBefore).to.be.true;
-    })
+  expect(timePassedAfter).to.be.false;
-})
+});
+
+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 => {
+    expect(stringArg).equal('heyThere');
+  });
+});
+
+tap.test('smartdelay.Timeout', async () => {
+  let timeout = new smartdelay.Timeout(2000);
+  await timeout.promise;
+});
+
+tap.test('smartdelay.Timeout should cancel', async tools => {
+  let timeout = new smartdelay.Timeout(60000);
+  timeout.cancel();
+});
+
+tap.start();

ts/index.ts

@@ -1,13 +1,63 @@
-import 'typings-global'
+import * as smartpromise from '@pushrocks/smartpromise';
 
+/**
+ * delay something, works like setTimeout
+ * @param timeInMillisecond
+ * @param passOn
+ */
 export let delayFor = async <T>(timeInMillisecond: number, passOn?: T) => {
   await new Promise((resolve, reject) => {
-        setTimeout(
+    setTimeout(() => {
-            () => {
+      resolve();
-                resolve()
+    }, timeInMillisecond);
-            },
+  });
-            timeInMillisecond
+  return passOn;
-        )
+};
-    })
+
-    return passOn
+/**
+ * delay for a random time
+ */
+export let delayForRandom = async <T>(
+  timeMinInMillisecond: number,
+  timeMaxInMillisecond: number,
+  passOn?: T
+) => {
+  await new Promise((resolve, reject) => {
+    setTimeout(() => {
+      resolve();
+    }, Math.random() * (timeMaxInMillisecond - timeMinInMillisecond) + timeMinInMillisecond);
+  });
+  return passOn;
+};
+
+export class Timeout<T> {
+  promise: Promise<T>;
+  private _deferred: smartpromise.Deferred<T>;
+  private _timeout: any;
+  private _cancelled: boolean = false;
+
+  constructor(timeInMillisecondArg, passOn?: T) {
+    this._deferred = smartpromise.defer<T>();
+    this.promise = this._deferred.promise;
+    this._timeout = setTimeout(() => {
+      if (!this._cancelled) {
+        this._deferred.resolve(passOn);
+      }
+    }, timeInMillisecondArg);
+  }
+
+  /**
+   * unreffing a timeout causes the node process to not wait for completion before exit
+   */
+  public makeUnrefed() {
+    this._timeout.unref();
+  }
+
+  /**
+   * cancels the timer
+   */
+  public cancel() {
+    this._cancelled = true;
+    this.makeUnrefed();
+  }
 }

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }