@sha1n/about-time 0.0.11 → 0.0.12

package/dist/index.js

@@ -10,13 +10,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exponentialBackoffRetryPolicy = exports.simpleRetryPolicy = exports.fixedRetryPolicy = exports.retriable = exports.retryAround = exports.eventually = exports.until = exports.stopwatch = exports.timeBounded = exports.timeoutAround = exports.delay = exports.sleep = exports.toMilliseconds = void 0;
+exports.exponentialBackoffRetryPolicy = exports.simpleRetryPolicy = exports.fixedRetryPolicy = exports.retriable = exports.retryAround = exports.eventually = exports.until = exports.stopwatch = exports.timeBounded = exports.timeoutAround = exports.delayed = exports.delay = exports.sleep = exports.toMilliseconds = void 0;
 __exportStar(require("./lib/types"), exports);
 var toMilliseconds_1 = require("./lib/toMilliseconds");
 Object.defineProperty(exports, "toMilliseconds", { enumerable: true, get: function () { return toMilliseconds_1.toMilliseconds; } });
 var delay_1 = require("./lib/delay");
 Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return delay_1.sleep; } });
 Object.defineProperty(exports, "delay", { enumerable: true, get: function () { return delay_1.delay; } });
+Object.defineProperty(exports, "delayed", { enumerable: true, get: function () { return delay_1.delayed; } });
 var timeout_1 = require("./lib/timeout");
 Object.defineProperty(exports, "timeoutAround", { enumerable: true, get: function () { return timeout_1.timeoutAround; } });
 Object.defineProperty(exports, "timeBounded", { enumerable: true, get: function () { return timeout_1.timeBounded; } });

package/dist/types/index.d.ts

@@ -1,6 +1,6 @@
 export * from './lib/types';
 export { toMilliseconds } from './lib/toMilliseconds';
-export { sleep, delay } from './lib/delay';
+export { sleep, delay, delayed } from './lib/delay';
 export { timeoutAround, timeBounded } from './lib/timeout';
 export { stopwatch } from './lib/stopwatch';
 export { until, eventually } from './lib/eventually';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sha1n/about-time",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "A set of essential time related utilities",
   "repository": "https://github.com/sha1n/about-time",
   "author": "Shai Nagar",

package/dist/lib/timeunit.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toMilliseconds = exports.TimeUnit = void 0;
-var TimeUnit;
-(function (TimeUnit) {
-    TimeUnit[TimeUnit["Milliseconds"] = 1] = "Milliseconds";
-    TimeUnit[TimeUnit["Millisecond"] = 1] = "Millisecond";
-    TimeUnit[TimeUnit["Seconds"] = 1000] = "Seconds";
-    TimeUnit[TimeUnit["Second"] = 1000] = "Second";
-    TimeUnit[TimeUnit["Minutes"] = 60000] = "Minutes";
-    TimeUnit[TimeUnit["Minute"] = 60000] = "Minute";
-    TimeUnit[TimeUnit["Hours"] = 3600000] = "Hours";
-    TimeUnit[TimeUnit["Hour"] = 3600000] = "Hour";
-    TimeUnit[TimeUnit["Days"] = 86400000] = "Days";
-    TimeUnit[TimeUnit["Day"] = 86400000] = "Day";
-})(TimeUnit || (TimeUnit = {}));
-exports.TimeUnit = TimeUnit;
-/**
- * Converts time value in other units to milliseconds.
- *
- * @param time a time value to be converted
- * @param units the units of time
- * @returns the time value in milliseconds
- */
-function toMilliseconds(time, units) {
-    return time * (units ? units : 1);
-}
-exports.toMilliseconds = toMilliseconds;

package/dist/lib/utilities.js

@@ -1,133 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.eventually = exports.until = exports.stopwatch = exports.delay = exports.sleep = exports.timeBounded = exports.timeoutAround = void 0;
-const timeunit_1 = require("./timeunit");
-class TimeoutError extends Error {
-    constructor(message) {
-        super(message || 'Timeout');
-    }
-}
-/**
- * Zzzz...
- *
- * @param time the approximate time to sleep (expect it to be as accurate as setTimeout)
- * @param options timer options minus the time property
- * @returns a promise that resolves when the specified time has elapsed.
- */
-function sleep(time, options) {
-    return new Promise(resolve => {
-        const timeout = setTimeout(resolve, (0, timeunit_1.toMilliseconds)(time, options === null || options === void 0 ? void 0 : options.units));
-        if (options === null || options === void 0 ? void 0 : options.unref) {
-            timeout.unref();
-        }
-    });
-}
-exports.sleep = sleep;
-/**
- * Delays the execution of the specified action and returns its value.
- *
- * @param action a function to execute with delay
- * @param options timer options
- * @returns a promise that resolves when the specified time has elapsed.
- */
-function delay(action, options) {
-    const { time, units, unref } = options;
-    const delayMs = (0, timeunit_1.toMilliseconds)(time, units);
-    return new Promise((resolve, reject) => {
-        const timer = setTimeout(() => Promise.resolve(action()).then(resolve, reject), delayMs);
-        if (unref) {
-            timer.unref();
-        }
-    });
-}
-exports.delay = delay;
-/**
- * Return a function that returns the elapsed time relative to this call.
- * @returns a function
- */
-function stopwatch() {
-    const startTime = Date.now();
-    return (units) => {
-        return (Date.now() - startTime) / (units || timeunit_1.TimeUnit.Milliseconds);
-    };
-}
-exports.stopwatch = stopwatch;
-/**
- * Awaits a specified condition to evaluate to true with or without a timeout.
- *
- * @param condition the condition to wait for
- * @param options poll-options
- * @returns a promise that resolves when the condition becomes true, or rejects when a set timeout is crossed.
- */
-async function until(condition, options) {
-    const defaultInterval = 50;
-    const deadline = (options === null || options === void 0 ? void 0 : options.deadline) ? Date.now() + (0, timeunit_1.toMilliseconds)(options.deadline, options.units) : Number.MAX_VALUE;
-    const interval = (options === null || options === void 0 ? void 0 : options.interval) ? (0, timeunit_1.toMilliseconds)(options.interval, options.units) : defaultInterval;
-    return new Promise((resolve, reject) => {
-        const handle = setInterval(() => {
-            if (Date.now() > deadline) {
-                clearInterval(handle);
-                reject(new TimeoutError());
-            }
-            try {
-                if (condition()) {
-                    clearInterval(handle);
-                    resolve();
-                }
-            }
-            catch (e) {
-                clearInterval(handle);
-                reject(e);
-            }
-        }, interval);
-        if (options === null || options === void 0 ? void 0 : options.unref) {
-            handle.unref();
-        }
-    });
-}
-exports.until = until;
-/**
- * Alias to `until`
- */
-const eventually = until;
-exports.eventually = eventually;
-/**
- * Executes an action with a specified timeout. If the action times out, rejects with TimeoutError.
- *
- * @param action an action to execute with timeout
- * @param options timer options
- * @returns the action result
- */
-async function timeoutAround(action, options) {
-    const promisedAction = new Promise((resolve, reject) => {
-        try {
-            resolve(action());
-        }
-        catch (e) {
-            reject(e);
-        }
-    });
-    const race = new Promise((resolve, reject) => {
-        const timer = setTimeout(() => {
-            reject(new TimeoutError());
-        }, (0, timeunit_1.toMilliseconds)(options.time, options.units));
-        if (options.unref) {
-            timer.unref();
-        }
-        return Promise.resolve(promisedAction).then(r => {
-            clearTimeout(timer);
-            resolve(r);
-        }, err => {
-            clearTimeout(timer);
-            reject(err);
-        });
-    });
-    return race;
-}
-exports.timeoutAround = timeoutAround;
-function timeBounded(action, options) {
-    return () => {
-        return timeoutAround(action, options);
-    };
-}
-exports.timeBounded = timeBounded;

package/dist/types/lib/timeunit.d.ts

@@ -1,21 +0,0 @@
-declare enum TimeUnit {
-    Milliseconds = 1,
-    Millisecond = 1,
-    Seconds = 1000,
-    Second = 1000,
-    Minutes = 60000,
-    Minute = 60000,
-    Hours = 3600000,
-    Hour = 3600000,
-    Days = 86400000,
-    Day = 86400000
-}
-/**
- * Converts time value in other units to milliseconds.
- *
- * @param time a time value to be converted
- * @param units the units of time
- * @returns the time value in milliseconds
- */
-declare function toMilliseconds(time: number, units?: TimeUnit): number;
-export { TimeUnit, toMilliseconds };

package/dist/types/lib/utilities.d.ts

@@ -1,76 +0,0 @@
-import { TimeUnit } from './timeunit';
-declare type TimerOptions = {
-    /**
-     * The time to set
-     */
-    readonly time: number;
-    /**
-     * Optional units for the specified time
-     */
-    readonly units?: TimeUnit;
-    /**
-     * Whether to call unref on the timer
-     */
-    readonly unref?: boolean;
-};
-declare type PollOptions = {
-    /**
-     * The poll interval to set
-     */
-    readonly interval?: number;
-    /**
-     * The overall deadline to set
-     */
-    readonly deadline?: number;
-    /**
-     * Time units for specified time properties
-     */
-    readonly units?: TimeUnit;
-    /**
-     * Whether to call unref on any intervals/timers
-     */
-    readonly unref?: boolean;
-};
-/**
- * Zzzz...
- *
- * @param time the approximate time to sleep (expect it to be as accurate as setTimeout)
- * @param options timer options minus the time property
- * @returns a promise that resolves when the specified time has elapsed.
- */
-declare function sleep(time: number, options?: Omit<TimerOptions, 'time'>): Promise<void>;
-/**
- * Delays the execution of the specified action and returns its value.
- *
- * @param action a function to execute with delay
- * @param options timer options
- * @returns a promise that resolves when the specified time has elapsed.
- */
-declare function delay<T>(action: () => T | Promise<T>, options: TimerOptions): Promise<T>;
-/**
- * Return a function that returns the elapsed time relative to this call.
- * @returns a function
- */
-declare function stopwatch(): (units?: TimeUnit) => number;
-/**
- * Awaits a specified condition to evaluate to true with or without a timeout.
- *
- * @param condition the condition to wait for
- * @param options poll-options
- * @returns a promise that resolves when the condition becomes true, or rejects when a set timeout is crossed.
- */
-declare function until(condition: () => boolean, options?: PollOptions): Promise<void>;
-/**
- * Alias to `until`
- */
-declare const eventually: typeof until;
-/**
- * Executes an action with a specified timeout. If the action times out, rejects with TimeoutError.
- *
- * @param action an action to execute with timeout
- * @param options timer options
- * @returns the action result
- */
-declare function timeoutAround<T>(action: () => T | Promise<T>, options: TimerOptions): Promise<T>;
-declare function timeBounded<T>(action: () => T | Promise<T>, options: TimerOptions): () => Promise<T>;
-export { timeoutAround, timeBounded, sleep, delay, stopwatch, until, eventually };