@ehmpathy/uni-time 1.4.2 → 1.5.0

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export * from './checks/isUniDateTime';
 export * from './casts/toMillisecondsSinceEpoch';
 export * from './manipulate/addDuration';
 export * from './manipulate/subDuration';
+export * from './wrappers/waitFor';

package/dist/index.js

@@ -22,4 +22,5 @@ __exportStar(require("./checks/isUniDateTime"), exports);
 __exportStar(require("./casts/toMillisecondsSinceEpoch"), exports);
 __exportStar(require("./manipulate/addDuration"), exports);
 __exportStar(require("./manipulate/subDuration"), exports);
+__exportStar(require("./wrappers/waitFor"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,uDAAqC;AACrC,gDAA8B;AAC9B,qDAAmC;AACnC,yDAAuC;AACvC,mEAAiD;AACjD,2DAAyC;AACzC,2DAAyC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,uDAAqC;AACrC,gDAA8B;AAC9B,qDAAmC;AACnC,yDAAuC;AACvC,mEAAiD;AACjD,2DAAyC;AACzC,2DAAyC;AACzC,qDAAmC"}

package/dist/wrappers/waitFor.d.ts

@@ -0,0 +1,23 @@
+import { HelpfulError } from '@ehmpathy/error-fns';
+import { NotUndefined } from 'type-fns';
+import { UniDuration } from '../domain/UniDuration';
+export declare class WaitForTimedOutError extends HelpfulError {
+}
+/**
+ * tactic
+ * .what: wait for an output
+ * .why:
+ *   - enables waiting until some desired result is ready
+ *   - ensures best practices and a pit of success contract
+ *   - uses readable names for maintainability
+ */
+export declare const waitFor: <O>(extractor: () => Promise<O>, options?: {
+    /**
+     * the interval at which to check for completion
+     */
+    interval?: UniDuration;
+    /**
+     * the maximum duration to wait for, until timeout
+     */
+    timeout?: UniDuration;
+}) => Promise<NotUndefined<O>>;

package/dist/wrappers/waitFor.js

@@ -0,0 +1,63 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitFor = exports.WaitForTimedOutError = void 0;
+const error_fns_1 = require("@ehmpathy/error-fns");
+const type_fns_1 = require("type-fns");
+const UniDuration_1 = require("../domain/UniDuration");
+const sleep_1 = require("../utils/sleep");
+const DEFAULT_TIMEOUT = { seconds: 60 };
+const DEFAULT_INTERVAL = { seconds: 10 };
+class WaitForTimedOutError extends error_fns_1.HelpfulError {
+}
+exports.WaitForTimedOutError = WaitForTimedOutError;
+/**
+ * tactic
+ * .what: wait for an output
+ * .why:
+ *   - enables waiting until some desired result is ready
+ *   - ensures best practices and a pit of success contract
+ *   - uses readable names for maintainability
+ */
+const waitFor = (
+/**
+ * the procedure which extracts some output that we are waiting for
+ *
+ * note
+ * - waitFor waits until the extractor returns a value other than `void` or `undefined`
+ */
+extractor, 
+/**
+ * options to control the wait
+ */
+options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    // define the timeout and interval
+    const timeout = (_a = options === null || options === void 0 ? void 0 : options.timeout) !== null && _a !== void 0 ? _a : DEFAULT_TIMEOUT;
+    const interval = (_b = options === null || options === void 0 ? void 0 : options.interval) !== null && _b !== void 0 ? _b : DEFAULT_INTERVAL;
+    // track the timestamps of interest
+    const startAtMSE = new Date().getTime();
+    const timeoutAtMSE = startAtMSE + (0, UniDuration_1.toMilliseconds)(timeout);
+    // check each interval
+    while (new Date().getTime() < timeoutAtMSE) {
+        const output = yield extractor();
+        if ((0, type_fns_1.isNotUndefined)(output))
+            return output;
+        yield (0, sleep_1.sleep)(interval);
+    }
+    // throw an error if reached here, since it implies a timeout
+    throw new WaitForTimedOutError('no output returned from waitFor.extractor', {
+        interval,
+        timeout,
+    });
+});
+exports.waitFor = waitFor;
+//# sourceMappingURL=waitFor.js.map

package/dist/wrappers/waitFor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitFor.js","sourceRoot":"","sources":["../../src/wrappers/waitFor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAAmD;AACnD,uCAAwD;AAExD,uDAAoE;AACpE,0CAAuC;AAEvC,MAAM,eAAe,GAAgB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AACrD,MAAM,gBAAgB,GAAgB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;AAEtD,MAAa,oBAAqB,SAAQ,wBAAY;CAAG;AAAzD,oDAAyD;AAEzD;;;;;;;GAOG;AACI,MAAM,OAAO,GAAG;AACrB;;;;;GAKG;AACH,SAA2B;AAE3B;;GAEG;AACH,OAUC,EACyB,EAAE;;IAC5B,kCAAkC;IAClC,MAAM,OAAO,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,eAAe,CAAC;IACpD,MAAM,QAAQ,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,mCAAI,gBAAgB,CAAC;IAEvD,mCAAmC;IACnC,MAAM,UAAU,GAAW,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;IAChD,MAAM,YAAY,GAAW,UAAU,GAAG,IAAA,4BAAc,EAAC,OAAO,CAAC,CAAC;IAElE,sBAAsB;IACtB,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,YAAY,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,IAAI,IAAA,yBAAc,EAAC,MAAM,CAAC;YAAE,OAAO,MAAM,CAAC;QAC1C,MAAM,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED,6DAA6D;IAC7D,MAAM,IAAI,oBAAoB,CAAC,2CAA2C,EAAE;QAC1E,QAAQ;QACR,OAAO;KACR,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AA5CW,QAAA,OAAO,WA4ClB"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ehmpathy/uni-time",
   "author": "ehmpathy",
   "description": "a glossary of universally intuitive time, date, and duration domain literals",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "repository": "ehmpathy/uni-time",
   "homepage": "https://github.com/ehmpathy/uni-time",
   "keywords": [