@kiwiproject/kiwi-test-js 0.5.0 → 0.5.1

package/dist/waitForIt/waitForIt.d.ts

@@ -1,11 +1,51 @@
 import { Time } from "convert";
+/**
+ * Creates a new wait condition with defaults.
+ *
+ * Impl Note: This will NOT do anything unless `.until()` is called.
+ */
 export declare function wait(): WaitFor;
 declare class WaitFor {
     private timeoutMs;
-    private checkIntervalMs;
+    private pollIntervalMs;
+    private pollDelayMs;
+    private alias;
+    private verbose;
     constructor();
-    atMost(time: number, units: Time): this;
-    checkEvery(time: number, units: Time): this;
+    /**
+     * Sets the amount of time between condition checks to wait.
+     * @param time The amount of time till the next poll
+     * @param units The units that correspond to the time. Default is ms.
+     */
+    withPollInterval(time: number, units?: Time): this;
+    /**
+     * Sets the amount of time to wait until the condition is first checked.
+     * @param time The amount of time to wait
+     * @param units The units corresponding to the time. Default is ms.
+     */
+    withPollDelay(time: number, units?: Time): this;
+    /**
+     * A unique name to give this wait check. Useful if more than one wait condition is used.
+     *
+     * @param alias The name to give this wait check.
+     */
+    withAlias(alias: string): this;
+    /**
+     * Enables debug logging during the wait check.
+     */
+    withVerbose(): this;
+    /**
+     * Sets the max time to wait for the condition to return true.
+     * @param time The amount of total time to wait for the condition to return true.
+     * @param units The units that correspond to the time. Default is ms.
+     */
+    atMost(time: number, units?: Time): this;
+    /**
+     * Kicks off the wait check. The condition will be checked every pollInterval for a truthy response. If the max time
+     * to wait is reached, then a rejected Promise will be returned. If the condition becomes true, then a resolved Promise
+     * will be returned.
+     * @param cb The function to check if the condition is true or false.
+     */
     until(cb: () => boolean): Promise<string>;
 }
 export {};

package/dist/waitForIt/waitForIt.js

@@ -5,40 +5,103 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.wait = void 0;
 const convert_1 = __importDefault(require("convert"));
+/**
+ * Creates a new wait condition with defaults.
+ *
+ * Impl Note: This will NOT do anything unless `.until()` is called.
+ */
 function wait() {
     return new WaitFor();
 }
 exports.wait = wait;
 class WaitFor {
     constructor() {
-        this.timeoutMs = 500;
-        this.checkIntervalMs = 100;
+        this.timeoutMs = 4000;
+        this.pollIntervalMs = 100;
+        this.pollDelayMs = 0;
+        this.verbose = false;
     }
-    atMost(time, units) {
-        this.timeoutMs = (0, convert_1.default)(time, units).to("ms");
+    /**
+     * Sets the amount of time between condition checks to wait.
+     * @param time The amount of time till the next poll
+     * @param units The units that correspond to the time. Default is ms.
+     */
+    withPollInterval(time, units = "ms") {
+        this.pollIntervalMs = (0, convert_1.default)(time, units).to("ms");
+        return this;
+    }
+    /**
+     * Sets the amount of time to wait until the condition is first checked.
+     * @param time The amount of time to wait
+     * @param units The units corresponding to the time. Default is ms.
+     */
+    withPollDelay(time, units = "ms") {
+        this.pollDelayMs = (0, convert_1.default)(time, units).to("ms");
+        return this;
+    }
+    /**
+     * A unique name to give this wait check. Useful if more than one wait condition is used.
+     *
+     * @param alias The name to give this wait check.
+     */
+    withAlias(alias) {
+        this.alias = alias;
+        return this;
+    }
+    /**
+     * Enables debug logging during the wait check.
+     */
+    withVerbose() {
+        this.verbose = true;
         return this;
     }
-    checkEvery(time, units) {
-        this.checkIntervalMs = (0, convert_1.default)(time, units).to("ms");
+    /**
+     * Sets the max time to wait for the condition to return true.
+     * @param time The amount of total time to wait for the condition to return true.
+     * @param units The units that correspond to the time. Default is ms.
+     */
+    atMost(time, units = "ms") {
+        this.timeoutMs = (0, convert_1.default)(time, units).to("ms");
         return this;
     }
+    /**
+     * Kicks off the wait check. The condition will be checked every pollInterval for a truthy response. If the max time
+     * to wait is reached, then a rejected Promise will be returned. If the condition becomes true, then a resolved Promise
+     * will be returned.
+     * @param cb The function to check if the condition is true or false.
+     */
     until(cb) {
-        const totalTries = this.timeoutMs / this.checkIntervalMs;
+        const totalTries = this.timeoutMs / this.pollIntervalMs;
+        const aliasText = this.alias ? `with alias ${this.alias} ` : "";
+        if (this.verbose) {
+            console.log(`Waiting for condition ${aliasText}for up to ${totalTries} attempts checking every ${this.pollIntervalMs} ms`);
+        }
         return new Promise((resolve, reject) => {
             let tries = 1;
             const loop = () => {
                 if (cb.apply(this)) {
-                    resolve(`Condition met after ${tries} of ${totalTries} tries`);
+                    if (this.verbose) {
+                        console.log(`Condition ${aliasText}met after ${tries} of ${totalTries} tries`);
+                    }
+                    resolve(`Condition ${aliasText}met after ${tries} of ${totalTries} tries`);
                 }
                 else if (tries > totalTries) {
-                    reject(new Error(`Condition was not met after ${totalTries} tries`));
+                    if (this.verbose) {
+                        console.log(`Condition ${aliasText}was not met after ${totalTries} tries`);
+                    }
+                    reject(new Error(`Condition ${aliasText}was not met after ${totalTries} tries`));
                 }
                 else {
                     tries += 1;
-                    setTimeout(loop, this.checkIntervalMs);
+                    setTimeout(loop, this.pollIntervalMs);
                 }
             };
-            loop();
+            if (this.pollDelayMs > 0) {
+                setTimeout(loop, this.pollDelayMs);
+            }
+            else {
+                loop();
+            }
         });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-test-js",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "kiwi-test-js is a test utility library. Most of these utilities are ports from the Java Kiwi-test library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",