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

package/package.json

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

package/test-utils/later.d.ts

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

package/test-utils/waitFor.d.ts

@@ -1,17 +1,27 @@
+/** Options supported by {@link waitFor} and {@link waitUntil}. */
+interface WaitOptions {
+    /** The maximum time to wait for the resolver to be fulfilled. Default is 150ms. */
+    timeout?: number;
+    /** The interval in milliseconds to check the resolver. Default is 5ms. */
+    interval?: number;
+    /** The maximum number of checks to perform. */
+    maxChecks?: number;
+}
 /**
- * Waits for a resolver to return a thing.
+ * Waits for a resolver to return a value.
+ * Continues checking until `resolver` does _not_ throw an error.
+ *
  * @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
+ * import { waitFor } from "test-utils/waitFor";
+ *
  * const result = await waitFor(() => {
  *   const value = getValue();
  *   if (value === undefined) {
@@ -22,25 +32,21 @@
  * assert.equal(result, "myValue");
  * ```
  */
-declare function waitFor<T>(resolver: () => Promise<T> | T, options?: {
-    timeout?: number;
-    interval?: number;
-    maxChecks?: number;
-    failOnError?: boolean;
-}): Promise<T>;
+declare function waitFor<T>(resolver: () => Promise<T> | T, options?: WaitOptions): Promise<T>;
+type Falsy = false | 0 | null | undefined;
+type NonFalsy<T> = Exclude<T, Falsy>;
 /**
- * This function behaves like {@link waitFor} but it will reject the promise if the resolver throws an error.
+ * This function is similar to like {@link waitFor} but it will wait until the `resolver` returns a truthy value.
+ * If the `resolver` throws an error, the function rejects immediately.
+ *
  * @see waitFor
  */
-declare function waitUntil<T>(resolver: () => Promise<T> | T, options?: {
-    timeout?: number;
-    interval?: number;
-    maxChecks?: number;
-}): Promise<T>;
+declare function waitUntil<T>(resolver: () => Promise<T> | T, options?: WaitOptions): Promise<NonFalsy<T>>;
 /**
- * Waits for a certain amount of time.
- * @param timeout The time to wait in seconds.
+ * Sleeps for a certain amount of time.
+ *
+ * @param timeout The time to wait in milliseconds.
  */
-declare function wait(timeout?: number): Promise<void>;
+declare function sleep(timeout?: number): Promise<void>;
 
-export { wait, waitFor, waitUntil };
+export { type WaitOptions, sleep, waitFor, waitUntil };

package/test-utils/waitForProperty.d.ts

@@ -23,6 +23,7 @@ import Promise$1 from 'apprt-core/CancelablePromise';
  *                           (v) => v === 1,
  *                           {timeout:100});
  *   assert.equal(value, 1);
+ * @deprecated use {@link test-utils/waitFor} instead.
  */
 declare function waitForProperty(mutable: Mutable | Accessor | Stateful, property: string, comparatorOrExpectedValue?: Function | undefined | value, { timeout }?: Object | undefined): Promise$1<any>;