@tecgovtnzwebdev/puppeteer 3.0.1

package/wait-until.ts

@@ -0,0 +1,48 @@
+import * as puppeteer from 'puppeteer';
+import { wait } from './wait';
+
+/**
+ * @deprecated Use `repeatUntil` instead.
+ */
+export async function waitUntil(page: puppeteer.Page, waitFunction: () => Promise<boolean>, errorMessage = 'Timed out waiting for something', timeOut = 5000, pollInterval = 100) {
+    const endTime = Date.now() + timeOut;
+    let conditionMet = await waitFunction();
+    while (!conditionMet && Date.now() < endTime) {
+        await new Promise(resolve => setTimeout(resolve, pollInterval));
+        conditionMet = await waitFunction();
+    }
+    if (!conditionMet) {
+        throw new Error(errorMessage);
+    }
+}
+
+/**
+ * Repeats an operation until a specified condition is met or a timeout occurs.
+ *
+ * @param page - The Puppeteer `Page` instance to operate on.
+ * @param operation - An asynchronous function that returns a boolean indicating whether the condition is met.
+ * @param errorMessage - The error message to throw if the timeout is reached before the condition is met. Defaults to 'Timed out waiting for something'.
+ * @param timeOut - The maximum time to wait (in milliseconds) before throwing an error. Defaults to 5000 ms.
+ * @param pollInterval - The interval (in milliseconds) at which the condition is checked. Defaults to 100 ms.
+ * @throws Will throw an error with the provided `errorMessage` if the condition is not met within the timeout period.
+ */
+export async function repeatUntil(
+    operation: () => Promise<boolean | undefined>,
+    errorMessage = 'Timed out waiting for something',
+    timeOut = 5000,
+    pollInterval = 100) {
+    // The absolute end time this operation should run until (in milliseconds)
+    const endTime = Date.now() + timeOut;
+
+    do {
+        // Call the operation and check if it returns true
+        if (await operation()) {
+            return;
+        }
+
+        // Wait for the specified poll interval before checking again
+        await wait(pollInterval);
+    } while (Date.now() < endTime);
+
+    throw new Error(errorMessage);
+}

package/wait.ts

@@ -0,0 +1,9 @@
+/**
+ * Waits for a specified period of time.
+ *
+ * @param period - The time to wait in milliseconds.
+ * @returns A promise that resolves after the specified period.
+ */
+export const wait = async (period: number) => {
+  await new Promise(resolve => setTimeout(resolve, period));
+}