npmpackage.info

Gathering detailed insights and metrics for async-wait-until

Other packages similar to async-wait-until

async-until

4.0.1

Wait until a given callback returns true

async-test-util

2.5.0

Util-functions that are be useful in async tests

wait-until-async

1.0.1

Simple library which builds on top of wait-promise, but provides utilities for conditions being async functions.

async-wait-for-promise

1.3.0

Wait for a condition or timeout to occur

Gathering detailed insights and metrics for async-wait-until

async-wait-until - 2.0.27 | npmpackage.info

async-wait-until

Waits for an expectation to be truthy. A small library with a convenient API suitable for unit and integration testing

2.0.27

MIT

TypeScript

764.00 B

10,894,594 5.5

Installations

npm install async-wait-until

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>= 0.14.0

Node Version

20.19.0

NPM Version

10.8.2 Score

99.4

Supply Chain

100

Quality

84.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

61

Closed

24

Merged

37

Issues

Open

0

Total

9

Closed

9

Releases

2.0.27

Updated on Apr 04, 2025

2.0.25

Updated on Apr 04, 2025

2.0.24

Updated on Apr 04, 2025

2.0.23

Updated on Feb 04, 2025

2.0.22

Updated on Jan 29, 2025

2.0.18

Updated on Dec 08, 2024

View All 20 releases

Languages

TypeScript

JavaScript

TypeScript (73.66%)

JavaScript (26.34%)

Developer

devlato

Download Statistics

Total Downloads

10,894,594

Last Day

15,824

Last Week

98,031

Last Month

416,631

Last Year

3,919,641

GitHub Statistics

MIT License

76 Stars

260 Commits

13 Forks

2 Watchers

19 Branches

3 Contributors

Updated on Apr 04, 2025

Bundle Size

1.47 kB

Minified

764.00 B

Minified + Gzipped

Bundlephobia

Sponsor this package

http://paypal.me/devlatoau

Maintainers

View All 3 Contributors

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

NPM Version

10.8.2

Node Version

20.19.0

Published on

Apr 04, 2025

Total Downloads

Cumulative downloads

Total Downloads

10,894,594

Last Day

21.8%

15,824

Compared to previous day

Last Week

13.2%

98,031

Compared to previous week

Last Month

-7.2%

416,631

Compared to previous month

Last Year

53%

3,919,641

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

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).

npm version MIT License

📖 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.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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: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/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/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: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: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: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: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
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: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
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

6

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

5

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.5

/10

Last Scanned on 2025-05-05

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

Other packages similar to async-wait-until

Other packages similar to async-wait-until

async-wait-until

Installations

Developer Guide

Yes

CommonJS, ESM

>= 0.14.0

20.19.0

10.8.2

Score

Pull Requests

0

61

24

37

Issues

0

9

9

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

1.47 kB

764.00 B

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

10,894,594

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

async-wait-until

📖 Detailed Documentation

🚀 Installation

🛠️ How to Use

Basic Example: Wait for a DOM Element

Handling Timeouts

📚 API

waitUntil(predicate, options)

💡 Recipes

Wait Indefinitely

Adjust Retry Interval

🧪 Development and Testing

📝 Links

10

10

10

10

10

6

6

5

0

0

0

0

0

5.5

/10

`waitUntil(predicate, options)`