@conterra/ct-mapapps-typings 4.18.3-next.20240903035319 → 4.18.3-next.20240904040710

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@conterra/ct-mapapps-typings",
-    "version": "4.18.3-next.20240903035319",
+    "version": "4.18.3-next.20240904040710",
     "description": "TypeDefinitions for ct-mapapps",
     "author": "conterra",
     "license": "Apache-2.0"

package/test-utils/later.d.ts

@@ -16,6 +16,7 @@ import Promise$1 from 'apprt-core/Promise';
  *          // check state
  *      });
  * }
+ * @deprecated use {@link waitFor} instead.
  */
 declare function later(cb?: number | Function | undefined, delay?: number | undefined): Promise$1<any>;
 /**
@@ -35,6 +36,7 @@ declare function later(cb?: number | Function | undefined, delay?: number | unde
  *          // check state
  *      });
  * }
+ * @deprecated use {@link waitFor} instead.
  */
 declare function customDelay(delay: number): Function;
 

package/test-utils/waitFor.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Waits for a resolver to return a thing.
+ * @param resolver The condition/resolver to be fulfilled.
+ * The resolver needs to throw an error to communicate that the value is not yet ready.
+ * @param options Options for the wait.
+ * @param options.timeout The maximum time to wait for the resolver to be fulfilled. Default is 150ms.
+ * @param options.interval The interval in milliseconds to check the resolver. Default is 5ms.
+ * @param options.maxChecks The maximum number of checks to perform.
+ * @param options.failOnError If true, the promise will be rejected if the resolver throws an error,
+ *  this behavior is the same as {@link waitUntil}.
+ * @returns A promise that transports the value of the resolver.
+ * @throws An error if the condition is not fulfilled within the specified timeout.
+ * @example
+ * ```ts
+ * const result = await waitFor(() => {
+ *   const value = getValue();
+ *   if (value === undefined) {
+ *      throw new Error("Value not ready");
+ *   }
+ *   return value;
+ * });
+ * assert.equal(result, "myValue");
+ * ```
+ */
+declare function waitFor<T>(resolver: () => Promise<T> | T, options?: {
+    timeout?: number;
+    interval?: number;
+    maxChecks?: number;
+    failOnError?: boolean;
+}): Promise<T>;
+/**
+ * This function behaves like {@link waitFor} but it will reject the promise if the resolver throws an error.
+ * @see waitFor
+ */
+declare function waitUntil<T>(resolver: () => Promise<T> | T, options?: {
+    timeout?: number;
+    interval?: number;
+    maxChecks?: number;
+}): Promise<T>;
+/**
+ * Waits for a certain amount of time.
+ * @param timeout The time to wait in seconds.
+ */
+declare function wait(timeout?: number): Promise<void>;
+
+export { wait, waitFor, waitUntil };