@dr.pogodin/js-utils 0.0.1 → 0.0.2

package/README.md

@@ -2,9 +2,9 @@
 
 # JS Utils
 
-[_TODO: Latest NPM version / Link to NPM package page_]
-[_TODO: NPM monthly downloads count / Link to NPM package page_]
-[_TODO: CircleCI status of primary branch build / Link to CircleCI project page_]
+[![Latest NPM Release](https://img.shields.io/npm/v/@dr.pogodin/js-utils.svg)](https://www.npmjs.com/package/@dr.pogodin/js-utils)
+[![NPM Downloads](https://img.shields.io/npm/dm/@dr.pogodin/js-utils.svg)](https://www.npmjs.com/package/@dr.pogodin/js-utils)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/birdofpreyru/js-utils/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/birdofpreyru/js-utils)
 [![GitHub repo stars](https://img.shields.io/github/stars/birdofpreyru/js-utils?style=social)](https://github.com/birdofpreyru/js-utils)
 
 The aim for this repo/package is to move in from the [React Utils] the pieces

package/js/time.d.ts

@@ -1,8 +1,31 @@
+import Barrier, { type Executor } from './Barrier';
 export declare const SEC_MS = 1000;
 export declare const MIN_MS: number;
 export declare const HOUR_MS: number;
 export declare const DAY_MS: number;
 export declare const YEAR_MS: number;
+export declare class Timer<T> extends Barrier<void, T> {
+    private p_abort;
+    private p_timeout?;
+    get abort(): () => void;
+    get timeout(): number | undefined;
+    /**
+     * Creates a new, non-initialized instance of Timer. Call .init() method
+     * to actually initialize and launch the timer.
+     *
+     * NOTE: Although it might be tempting to accept `timeout` value as
+     * a constructor's argument, it won't work well, because Timer is an
+     * extension of Promise (via Barrier), and the way Promises works (in
+     * particular their .then() method, which internally calls constructor()
+     * with special executor) does not play along with initalization depending
+     * on custom parameters done in constructor().
+     *
+     * @param executor
+     */
+    constructor(executor?: Executor<T>);
+    init(timeout: number): Timer<T>;
+    then<TR1, TR2>(onFulfilled?: ((value: T) => TR1 | PromiseLike<TR1>) | null, onRejected?: ((reason: any) => TR2 | PromiseLike<TR2>) | null): Timer<TR1 | TR2>;
+}
 /**
  * Creates a Promise, which resolves after the given timeout.
  * @param {number} timeout Timeout [ms].
@@ -10,4 +33,4 @@ export declare const YEAR_MS: number;
  *  .abort() method attached, which cancels the pending timer resolution
  *  (without resolving or rejecting the barrier).
  */
-export declare function timer(timeout: number): Promise<void>;
+export declare function timer(timeout: number): Timer<void>;

package/js/time.js

@@ -1,43 +1,60 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    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) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timer = exports.YEAR_MS = exports.DAY_MS = exports.HOUR_MS = exports.MIN_MS = exports.SEC_MS = void 0;
+exports.timer = exports.Timer = exports.YEAR_MS = exports.DAY_MS = exports.HOUR_MS = exports.MIN_MS = exports.SEC_MS = void 0;
 const Barrier_1 = __importDefault(require("./Barrier"));
 exports.SEC_MS = 1000;
 exports.MIN_MS = 60 * exports.SEC_MS;
 exports.HOUR_MS = 60 * exports.MIN_MS;
 exports.DAY_MS = 24 * exports.HOUR_MS;
 exports.YEAR_MS = 365 * exports.DAY_MS;
+// TODO: Ok, as we have ended up with a Timer class, mostly to achieve a good
+// TypeScript typing for timer() function, it makes sense to expose the class
+// from the library as well, and it should be documented later.
 class Timer extends Barrier_1.default {
     get abort() { return this.p_abort; }
-    constructor(executor, timeout = 0) {
+    get timeout() { return this.p_timeout; }
+    /**
+     * Creates a new, non-initialized instance of Timer. Call .init() method
+     * to actually initialize and launch the timer.
+     *
+     * NOTE: Although it might be tempting to accept `timeout` value as
+     * a constructor's argument, it won't work well, because Timer is an
+     * extension of Promise (via Barrier), and the way Promises works (in
+     * particular their .then() method, which internally calls constructor()
+     * with special executor) does not play along with initalization depending
+     * on custom parameters done in constructor().
+     *
+     * @param executor
+     */
+    constructor(executor) {
         super(executor);
+        this.p_abort = () => { };
+    }
+    init(timeout) {
+        if (this.p_timeout !== undefined) {
+            throw Error('This Timer is initialized already');
+        }
+        this.p_timeout = timeout;
         if (timeout > 0) {
             const id = setTimeout(super.resolve.bind(this), timeout);
             this.p_abort = () => clearTimeout(id);
         }
         else {
-            this.p_abort = () => { };
             super.resolve();
         }
+        return this;
     }
     then(onFulfilled, onRejected) {
         const res = super.then(onFulfilled, onRejected);
-        res.p_abort = this.p_abort;
+        if (this.timeout !== undefined)
+            res.init(this.timeout);
         return res;
     }
 }
+exports.Timer = Timer;
 /**
  * Creates a Promise, which resolves after the given timeout.
  * @param {number} timeout Timeout [ms].
@@ -46,8 +63,7 @@ class Timer extends Barrier_1.default {
  *  (without resolving or rejecting the barrier).
  */
 function timer(timeout) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Timer(undefined, timeout);
-    });
+    const t = new Timer();
+    return t.init(timeout);
 }
 exports.timer = timer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dr.pogodin/js-utils",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Collection of JavaScript (TypeScript) utilities.",
   "main": "js/index",
   "react-native": "ts/index",

package/ts/time.ts

@@ -6,20 +6,48 @@ export const HOUR_MS = 60 * MIN_MS;
 export const DAY_MS = 24 * HOUR_MS;
 export const YEAR_MS = 365 * DAY_MS;
 
-class Timer<T> extends Barrier<void, T> {
+// TODO: Ok, as we have ended up with a Timer class, mostly to achieve a good
+// TypeScript typing for timer() function, it makes sense to expose the class
+// from the library as well, and it should be documented later.
+export class Timer<T> extends Barrier<void, T> {
   private p_abort: () => void;
 
+  private p_timeout?: number;
+
   get abort(): () => void { return this.p_abort; }
 
-  constructor(executor?: Executor<T>, timeout: number = 0) {
+  get timeout(): number | undefined { return this.p_timeout; }
+
+  /**
+   * Creates a new, non-initialized instance of Timer. Call .init() method
+   * to actually initialize and launch the timer.
+   *
+   * NOTE: Although it might be tempting to accept `timeout` value as
+   * a constructor's argument, it won't work well, because Timer is an
+   * extension of Promise (via Barrier), and the way Promises works (in
+   * particular their .then() method, which internally calls constructor()
+   * with special executor) does not play along with initalization depending
+   * on custom parameters done in constructor().
+   *
+   * @param executor
+   */
+  constructor(executor?: Executor<T>) {
     super(executor);
+    this.p_abort = () => {};
+  }
+
+  init(timeout: number): Timer<T> {
+    if (this.p_timeout !== undefined) {
+      throw Error('This Timer is initialized already');
+    }
+    this.p_timeout = timeout;
     if (timeout > 0) {
       const id = setTimeout(super.resolve.bind(this), timeout);
       this.p_abort = () => clearTimeout(id);
     } else {
-      this.p_abort = () => {};
       super.resolve();
     }
+    return this;
   }
 
   then<TR1, TR2>(
@@ -27,7 +55,7 @@ class Timer<T> extends Barrier<void, T> {
     onRejected?: ((reason: any) => TR2 | PromiseLike<TR2>) | null,
   ): Timer<TR1 | TR2> {
     const res = <Timer<TR1 | TR2>> super.then(onFulfilled, onRejected);
-    res.p_abort = this.p_abort;
+    if (this.timeout !== undefined) res.init(this.timeout);
     return res;
   }
 }
@@ -39,6 +67,7 @@ class Timer<T> extends Barrier<void, T> {
  *  .abort() method attached, which cancels the pending timer resolution
  *  (without resolving or rejecting the barrier).
  */
-export async function timer(timeout: number) {
-  return new Timer<void>(undefined, timeout);
+export function timer(timeout: number): Timer<void> {
+  const t = new Timer<void>();
+  return t.init(timeout);
 }