async-wait-until

<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Documentation for async-wait-until v2.0.31</title><meta name="description" content="Documentation for Documentation for async-wait-until v2.0.31"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Documentation for async-wait-until v2.0.31</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Documentation for async-wait-until v2.0.31</h1></div><div class="tsd-panel tsd-typography"><h1 id="async-wait-until" class="tsd-anchor-link">async-wait-until<a href="#async-wait-until" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>A lightweight, zero-dependency library for waiting asynchronously until a specific condition is met. Works in any JavaScript environment that supports <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promises</a>, including older Node.js versions and browsers (with polyfills if necessary). <img src="https://img.shields.io/npm/v/async-wait-until" alt="npm version"> <a href="https://npmjs.org/package/async-wait-until"><img src="https://img.shields.io/npm/dw/async-wait-until" alt="npm downloads"></a> <img src="https://img.shields.io/npm/l/async-wait-until" alt="MIT License"> <a href="https://qlty.sh/gh/devlato/projects/async-wait-until"><img src="https://qlty.sh/gh/devlato/projects/async-wait-until/maintainability.svg" alt="Maintainability"></a> <h2 id="✨-features" class="tsd-anchor-link">✨ Features<a href="#✨-features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li>🚀 Zero dependencies - Lightweight and fast</li> <li>🔧 TypeScript support - Full TypeScript definitions included</li> <li>🌐 Universal compatibility - Works in Node.js and browsers</li> <li>⚡ Flexible configuration - Customizable timeouts and intervals</li> <li>🎯 Promise-based - Clean async/await syntax</li> <li>📦 Multiple formats - UMD, ESM, and additional format bundles</li> <li>🛡️ Error handling - Built-in timeout error handling</li> </ul> <h2 id="📚-table-of-contents" class="tsd-anchor-link">📚 Table of Contents<a href="#📚-table-of-contents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li><a href="#-installation">Installation</a></li> <li><a href="#%EF%B8%8F-how-to-use">How to Use</a></li> <li><a href="#-api">API Reference</a></li> <li><a href="#-typescript-usage">TypeScript Usage</a></li> <li><a href="#-recipes">Recipes</a></li> <li><a href="#-browser-compatibility">Browser Compatibility</a></li> <li><a href="#-troubleshooting">Troubleshooting</a></li> <li><a href="#-development-and-testing">Development and Testing</a></li> <li><a href="#-links">Links</a></li> </ul> <h2 id="📖-detailed-documentation" class="tsd-anchor-link">📖 Detailed Documentation<a href="#📖-detailed-documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>For detailed documentation, visit <a href="https://devlato.github.io/async-wait-until/">https://devlato.github.io/async-wait-until/</a> <hr> <h2 id="🚀-installation" class="tsd-anchor-link">🚀 Installation<a href="#🚀-installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>Install using npm: <pre><code class="sh">npm install async-wait-until </code><button type="button">Copy</button></pre> The library includes UMD and ESM bundles (plus additional formats), so you can use it in any environment. <pre><code class="javascript">import { waitUntil } from 'async-wait-until'; // Example: Wait for an element to appear await waitUntil(() => document.querySelector('#target') !== null); </code><button type="button">Copy</button></pre> <hr> <h2 id="🛠️-how-to-use" class="tsd-anchor-link">🛠️ How to Use<a href="#🛠️-how-to-use" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="basic-example-wait-for-a-dom-element" class="tsd-anchor-link">Basic Example: Wait for a DOM Element<a href="#basic-example-wait-for-a-dom-element" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript">import { waitUntil } from 'async-wait-until'; const waitForElement = async () => { // Wait for an element with the ID "target" to appear const element = await waitUntil(() => document.querySelector('#target'), { timeout: 5000 }); console.log('Element found:', element); }; waitForElement(); </code><button type="button">Copy</button></pre> <h3 id="handling-timeouts" class="tsd-anchor-link">Handling Timeouts<a href="#handling-timeouts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>If the condition is not met within the timeout, a <code>TimeoutError</code> is thrown. <pre><code class="javascript">import { waitUntil, TimeoutError } from 'async-wait-until'; const waitForElement = async () => { try { const element = await waitUntil(() => document.querySelector('#target'), { timeout: 5000 }); console.log('Element found:', element); } catch (error) { if (error instanceof TimeoutError) { console.error('Timeout: Element not found'); } else { console.error('Unexpected error:', error); } } }; waitForElement(); </code><button type="button">Copy</button></pre> <hr> <h2 id="📚-api-reference" class="tsd-anchor-link">📚 API Reference<a href="#📚-api-reference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="waituntilpredicate-options" class="tsd-anchor-link"><code>waitUntil(predicate, options)</code><a href="#waituntilpredicate-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>Waits for the <code>predicate</code> function to return a truthy value and resolves with that value. Parameters: <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Required</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>predicate</code></td> <td><code>Function</code></td> <td>✅ Yes</td> <td>-</td> <td>A function that returns a truthy value (or a Promise for one).</td> </tr> <tr> <td><code>options.timeout</code></td> <td><code>number</code></td> <td>🚫 No</td> <td><code>5000</code> ms</td> <td>Maximum wait time before throwing <code>TimeoutError</code>. Use <code>WAIT_FOREVER</code> for no timeout.</td> </tr> <tr> <td><code>options.intervalBetweenAttempts</code></td> <td><code>number</code></td> <td>🚫 No</td> <td><code>50</code> ms</td> <td>Interval between predicate evaluations.</td> </tr> </tbody> </table> <h3 id="exported-constants" class="tsd-anchor-link">Exported Constants<a href="#exported-constants" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><table> <thead> <tr> <th>Name</th> <th>Value</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>WAIT_FOREVER</code></td> <td><code>∞</code></td> <td>Use for infinite timeout (no time limit).</td> </tr> <tr> <td><code>DEFAULT_TIMEOUT_IN_MS</code></td> <td><code>5000</code></td> <td>Default timeout duration in milliseconds.</td> </tr> <tr> <td><code>DEFAULT_INTERVAL_BETWEEN_ATTEMPTS_IN_MS</code></td> <td><code>50</code></td> <td>Default interval between attempts in milliseconds.</td> </tr> </tbody> </table> <h3 id="exported-classes" class="tsd-anchor-link">Exported Classes<a href="#exported-classes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li><code>TimeoutError</code> - Error thrown when timeout is reached before condition is met.</li> </ul> <hr> <h2 id="🔧-typescript-usage" class="tsd-anchor-link">🔧 TypeScript Usage<a href="#🔧-typescript-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>This library is written in TypeScript and includes full type definitions. Here are some TypeScript-specific examples: <h3 id="basic-typescript-usage" class="tsd-anchor-link">Basic TypeScript Usage<a href="#basic-typescript-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript">import { waitUntil, TimeoutError, WAIT_FOREVER } from 'async-wait-until'; // The return type is automatically inferred const element = await waitUntil(() => document.querySelector('#target')); // element is typed as Element | null // With custom timeout and interval const result = await waitUntil( () => someAsyncCondition(), { timeout: 10000, intervalBetweenAttempts: 100 } ); </code><button type="button">Copy</button></pre> <h3 id="using-with-async-predicates" class="tsd-anchor-link">Using with Async Predicates<a href="#using-with-async-predicates" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript">// Async predicate example const checkApiStatus = async (): Promise<boolean> => { const response = await fetch('/api/health'); return response.ok; }; try { await waitUntil(checkApiStatus, { timeout: 30000 }); console.log('API is ready!'); } catch (error) { if (error instanceof TimeoutError) { console.error('API failed to become ready within 30 seconds'); } } </code><button type="button">Copy</button></pre> <h3 id="type-safe-options" class="tsd-anchor-link">Type-Safe Options<a href="#type-safe-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript">import { Options } from 'async-wait-until'; const customOptions: Options = { timeout: 15000, intervalBetweenAttempts: 200 }; await waitUntil(() => someCondition(), customOptions); </code><button type="button">Copy</button></pre> <hr> <h2 id="💡-recipes" class="tsd-anchor-link">💡 Recipes<a href="#💡-recipes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="wait-indefinitely" class="tsd-anchor-link">Wait Indefinitely<a href="#wait-indefinitely" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>Use <code>WAIT_FOREVER</code> to wait without a timeout: <pre><code class="javascript">import { waitUntil, WAIT_FOREVER } from 'async-wait-until'; await waitUntil(() => someCondition, { timeout: WAIT_FOREVER }); </code><button type="button">Copy</button></pre> <h3 id="adjust-retry-interval" class="tsd-anchor-link">Adjust Retry Interval<a href="#adjust-retry-interval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>Change how often the predicate is evaluated: <pre><code class="javascript">await waitUntil(() => someCondition, { intervalBetweenAttempts: 1000 }); // Check every 1 second </code><button type="button">Copy</button></pre> <h3 id="wait-for-api-response" class="tsd-anchor-link">Wait for API Response<a href="#wait-for-api-response" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript">const waitForApi = async () => { const response = await waitUntil(async () => { try { const res = await fetch('/api/status'); return res.ok ? res : null; } catch { return null; // Keep trying on network errors } }, { timeout: 30000, intervalBetweenAttempts: 1000 }); return response.json(); }; </code><button type="button">Copy</button></pre> <h3 id="wait-for-file-system-changes-nodejs" class="tsd-anchor-link">Wait for File System Changes (Node.js)<a href="#wait-for-file-system-changes-nodejs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript">import fs from 'fs'; import { waitUntil } from 'async-wait-until'; // Wait for a file to be created const filePath = './important-file.txt'; await waitUntil(() => fs.existsSync(filePath), { timeout: 10000 }); // Wait for file to have content await waitUntil(() => { if (fs.existsSync(filePath)) { return fs.readFileSync(filePath, 'utf8').trim().length > 0; } return false; }); </code><button type="button">Copy</button></pre> <h3 id="wait-for-database-connection" class="tsd-anchor-link">Wait for Database Connection<a href="#wait-for-database-connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript">const waitForDatabase = async (db) => { await waitUntil(async () => { try { await db.ping(); return true; } catch { return false; } }, { timeout: 60000, intervalBetweenAttempts: 2000 }); console.log('Database is ready!'); }; </code><button type="button">Copy</button></pre> <h3 id="wait-with-custom-conditions" class="tsd-anchor-link">Wait with Custom Conditions<a href="#wait-with-custom-conditions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript">// Wait for multiple conditions const waitForComplexCondition = async () => { return waitUntil(() => { const user = getCurrentUser(); const permissions = getPermissions(); const apiReady = isApiReady(); // All conditions must be true return user && permissions.length > 0 && apiReady; }); }; // Wait for specific value ranges const waitForTemperature = async () => { return waitUntil(async () => { const temp = await getSensorTemperature(); return temp >= 20 && temp <= 25 ? temp : null; }); }; </code><button type="button">Copy</button></pre> <hr> <h2 id="🌐-browser-compatibility" class="tsd-anchor-link">🌐 Browser Compatibility<a href="#🌐-browser-compatibility" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>This library works in any JavaScript environment that supports Promises: Node.js: ✅ Version 0.14.0 and above Modern Browsers: ✅ Chrome 32+, Firefox 29+, Safari 8+, Edge 12+ Legacy Browsers: ✅ With Promise polyfill (e.g., es6-promise) <h3 id="cdn-usage" class="tsd-anchor-link">CDN Usage<a href="#cdn-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="html"> <script src="https://unpkg.com/async-wait-until@latest/dist/index.js"></script> <script> // Available as global variable asyncWaitUntil.waitUntil(() => document.querySelector('#target')) .then(element => console.log('Found:', element)); </script> </code><button type="button">Copy</button></pre> <h3 id="es-modules-in-browser" class="tsd-anchor-link">ES Modules in Browser<a href="#es-modules-in-browser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="html"><script type="module"> import { waitUntil } from 'https://unpkg.com/async-wait-until@latest/dist/index.esm.js'; const element = await waitUntil(() => document.querySelector('#target')); console.log('Found:', element); </script> </code><button type="button">Copy</button></pre> <hr> <h2 id="🔍-troubleshooting" class="tsd-anchor-link">🔍 Troubleshooting<a href="#🔍-troubleshooting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3 id="common-issues" class="tsd-anchor-link">Common Issues<a href="#common-issues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>Q: My predicate never resolves, what's wrong? A: Make sure your predicate function returns a truthy value when the condition is met. Common mistakes: <ul> <li>Forgetting to return a value: <code>() => { someCheck(); }</code> ❌</li> <li>Correct: <code>() => { return someCheck(); }</code> ✅ or <code>() => someCheck()</code> ✅</li> </ul> Q: I'm getting unexpected timeout errors A: Check that: <ul> <li>Your timeout is long enough for the condition to be met</li> <li>Your predicate function doesn't throw unhandled errors</li> <li>Network requests in predicates have proper error handling</li> </ul> Q: The function seems to run forever A: This happens when: <ul> <li>Using <code>WAIT_FOREVER</code> without proper condition logic</li> <li>Predicate always returns falsy values</li> <li>Add logging to debug: <code>() => { const result = myCheck(); console.log(result); return result; }</code></li> </ul> Q: TypeScript compilation errors A: Ensure you're importing types correctly: <pre><code class="typescript">import { waitUntil, Options, TimeoutError } from 'async-wait-until'; </code><button type="button">Copy</button></pre> <h3 id="performance-tips" class="tsd-anchor-link">Performance Tips<a href="#performance-tips" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li>Use reasonable intervals (50-1000ms) to balance responsiveness and CPU usage</li> <li>For expensive operations, increase the interval: <code>{ intervalBetweenAttempts: 1000 }</code></li> <li>Implement proper error handling in async predicates to avoid unnecessary retries</li> <li>Consider using <code>WAIT_FOREVER</code> with external cancellation for long-running waits</li> </ul> <hr> <h2 id="🧪-development-and-testing" class="tsd-anchor-link">🧪 Development and Testing<a href="#🧪-development-and-testing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>Contributions are welcome! To contribute: <ol> <li>Fork and clone the repository.</li> <li>Install dependencies: <code>npm install</code>.</li> <li>Use the following commands:</li> </ol> <ul> <li>Run Tests: <code>npm test</code></li> <li>Lint Code: <code>npm run lint</code></li> <li>Format Code: <code>npm run format</code></li> <li>Build Library: <code>npm run build</code></li> <li>Generate Docs: <code>npm run docs</code></li> </ul> <hr> <h2 id="📝-links" class="tsd-anchor-link">📝 Links<a href="#📝-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li><a href="media/LICENSE">License</a></li> <li><a href="https://devlato.github.io/async-wait-until/">Detailed Documentation</a></li> <li><a href="media/CHANGELOG.md">Changelog</a> - Track version updates and changes</li> <li><a href="media/CONTRIBUTING.md">Contributing Guidelines</a> - How to contribute to the project</li> <li><a href="media/CODE_OF_CONDUCT.md">Code of Conduct</a> - Community standards and expectations</li> </ul> </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility">Member Visibility<ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#async-wait-until">async-wait-until</a><ul><li><a href="#✨-features">✨ Features</a></li><li><a href="#📚-table-of-contents">📚 Table of Contents</a></li><li><a href="#📖-detailed-documentation">📖 Detailed Documentation</a></li><li><a href="#🚀-installation">🚀 Installation</a></li><li><a href="#🛠️-how-to-use">🛠️ How to Use</a></li><li><ul><li><a href="#basic-example-wait-for-a-dom-element">Basic Example: Wait for a DOM Element</a></li><li><a href="#handling-timeouts">Handling Timeouts</a></li></ul></li><li><a href="#📚-api-reference">📚 API Reference</a></li><li><ul><li><a href="#waituntilpredicate-options">waitUntil(predicate, options)</a></li><li><a href="#exported-constants">Exported Constants</a></li><li><a href="#exported-classes">Exported Classes</a></li></ul></li><li><a href="#🔧-typescript-usage">🔧 TypeScript Usage</a></li><li><ul><li><a href="#basic-typescript-usage">Basic TypeScript Usage</a></li><li><a href="#using-with-async-predicates">Using with Async Predicates</a></li><li><a href="#type-safe-options">Type-Safe Options</a></li></ul></li><li><a href="#💡-recipes">💡 Recipes</a></li><li><ul><li><a href="#wait-indefinitely">Wait Indefinitely</a></li><li><a href="#adjust-retry-interval">Adjust Retry Interval</a></li><li><a href="#wait-for-api-response">Wait for API Response</a></li><li><a href="#wait-for-file-system-changes-nodejs">Wait for File System Changes (Node.js)</a></li><li><a href="#wait-for-database-connection">Wait for Database Connection</a></li><li><a href="#wait-with-custom-conditions">Wait with Custom Conditions</a></li></ul></li><li><a href="#🌐-browser-compatibility">🌐 Browser Compatibility</a></li><li><ul><li><a href="#cdn-usage">CDN Usage</a></li><li><a href="#es-modules-in-browser">ES Modules in Browser</a></li></ul></li><li><a href="#🔍-troubleshooting">🔍 Troubleshooting</a></li><li><ul><li><a href="#common-issues">Common Issues</a></li><li><a href="#performance-tips">Performance Tips</a></li></ul></li><li><a href="#🧪-development-and-testing">🧪 Development and Testing</a></li><li><a href="#📝-links">📝 Links</a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.