Gathering detailed insights and metrics for async-wait-until
Gathering detailed insights and metrics for async-wait-until
Waits for an expectation to be truthy. A small library with a convenient API suitable for unit and integration testing
Installations
npm install async-wait-untilDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS, ESM
Min. Node Version
>= 0.14.0
Node Version
20.19.0
NPM Version
10.8.2
Releases
20
Languages
2
TypeScript
JavaScript
TypeScript (73.66%)
JavaScript (26.34%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
78 Stars
260 Commits
13 Forks
2 Watchers
19 Branches
3 Contributors
Updated on Jul 09, 2025
Sponsor this package
Maintainers
1
Package Meta Information
Latest Version
2.0.27
Package Id
async-wait-until@2.0.27
Unpacked Size
323.41 kB
Size
52.80 kB
File Count
37
NPM Version
10.8.2
Node Version
20.19.0
Published on
Apr 04, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
28
@eslint/compat@rollup/plugin-commonjs@rollup/plugin-node-resolve@rollup/plugin-terser@rollup/plugin-typescript@types/jest@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parser@typhonjs-typedoc/typedoc-pkgcross-enveslinteslint-config-prettiereslint-plugin-prettierhuskyjestlint-stagedprettierrimrafrollupservets-jesttslibtypedoctypedoc-plugin-dt-linkstypedoc-plugin-mdn-linkstypedoc-plugin-merge-modulestypescript
async-wait-until
A lightweight, zero-dependency library for waiting asynchronously until a specific condition is met. Works in any JavaScript environment that supports Promises, including older Node.js versions and browsers (with polyfills if necessary).
📖 Detailed Documentation
For detailed documentation, visit https://devlato.github.io/async-wait-until/
🚀 Installation
Install using npm:
1npm install async-wait-until
The library includes UMD, CommonJS, and ESM bundles, so you can use it in any environment.
1import { waitUntil } from 'async-wait-until'; 2 3// Example: Wait for an element to appear 4await waitUntil(() => document.querySelector('#target') !== null);
🛠️ How to Use
Basic Example: Wait for a DOM Element
1import { waitUntil } from 'async-wait-until'; 2 3const waitForElement = async () => { 4 // Wait for an element with the ID "target" to appear 5 const element = await waitUntil(() => document.querySelector('#target'), { timeout: 5000 }); 6 console.log('Element found:', element); 7}; 8 9waitForElement();
Handling Timeouts
If the condition is not met within the timeout, a TimeoutError is thrown.
1import { waitUntil, TimeoutError } from 'async-wait-until'; 2 3const waitForElement = async () => { 4 try { 5 const element = await waitUntil(() => document.querySelector('#target'), { timeout: 5000 }); 6 console.log('Element found:', element); 7 } catch (error) { 8 if (error instanceof TimeoutError) { 9 console.error('Timeout: Element not found'); 10 } else { 11 console.error('Unexpected error:', error); 12 } 13 } 14}; 15 16waitForElement();
📚 API
waitUntil(predicate, options)
Waits for the predicate function to return a truthy value and resolves with that value.
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
predicate | Function | ✅ Yes | - | A function that returns a truthy value (or a Promise for one). |
options.timeout | number | 🚫 No | 5000 ms | Maximum wait time before throwing TimeoutError. Use WAIT_FOREVER for no timeout. |
options.intervalBetweenAttempts | number | 🚫 No | 50 ms | Interval between predicate evaluations. |
💡 Recipes
Wait Indefinitely
Use WAIT_FOREVER to wait without a timeout:
1import { waitUntil, WAIT_FOREVER } from 'async-wait-until'; 2 3await waitUntil(() => someCondition, { timeout: WAIT_FOREVER });
Adjust Retry Interval
Change how often the predicate is evaluated:
1await waitUntil(() => someCondition, { intervalBetweenAttempts: 1000 }); // Check every 1 second
🧪 Development and Testing
Contributions are welcome! To contribute:
- Fork and clone the repository.
- Install dependencies:
npm install. - Use the following commands:
- Run Tests:
npm test - Lint Code:
npm run lint - Format Code:
npm run format - Build Library:
npm run build - Generate Docs:
npm run docs
📝 Links
- License
- Detailed Documentation
- Changelog - Track version updates and changes
- Contributing Guidelines - How to contribute to the project
- Code of Conduct - Community standards and expectations
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool is run on all commits
Details
- Info: all commits (12) are checked with a SAST tool
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Reason
dependency not pinned by hash detected -- score normalized to 6
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:86: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/pr.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/pr.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/pr.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:195: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:202: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:88: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:99: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:162: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:183: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:216: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:231: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:236: update your workflow using https://app.stepsecurity.io/secureworkflow/devlato/async-wait-until/release.yml/master?enable=pin
- Info: 0 out of 36 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
- Info: 18 out of 18 npmCommand dependencies pinned
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'allow deletion' disabled on branch 'master'
- Info: 'force pushes' disabled on branch 'master'
- Warn: 'branch protection settings apply to administrators' is disabled on branch 'master'
- Warn: required approving review count is 1 on branch 'master'
- Info: codeowner review is required on branch 'master'
- Warn: no status checks found to merge onto branch 'master'
- Info: PRs are required in order to make changes on branch 'master'
Reason
Found 0/19 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/pr.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
4.9
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More