# p-whilst

> While a condition returns true, calls a function repeatedly, and then resolves the promise

Latest version **3.2.0** (published 2024-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install p-whilst
pnpm add p-whilst
yarn add p-whilst
bun add p-whilst
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2024-10-16 |
| First published | 2016-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=12 |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 57 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | promise, whilst, while, loop, wait, condition, conditional, async, await, promises, bluebird |

## Links

- npm: https://www.npmjs.com/package/p-whilst
- Repository: https://github.com/sindresorhus/p-whilst
- Homepage: https://github.com/sindresorhus/p-whilst#readme
- Issues: https://github.com/sindresorhus/p-whilst/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/p-whilst

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 3.2.0 (latest) — 2024-10-16
- 3.1.0 — 2023-07-21
- 3.0.0 — 2021-04-09
- 2.1.0 — 2019-04-03
- 2.0.0 — 2019-03-16
- 1.0.0 — 2016-10-21

## README

# p-whilst

> While a condition returns true, calls a function repeatedly, and then resolves the promise

Think async version of the [`while` statement](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/while).

## Install

```sh
npm install p-whilst
```

## Usage

```js
import pWhilst from 'p-whilst';

let count = 0;

await pWhilst(
	() => count < 5,
	() => count++
);

console.log(count);
//=> 5
```

## API

### pWhilst(condition, action, initialValue?)

While `condition` returns `true`, executes `action` repeatedly, and then resolves the promise to the result of the last call to `action`. Rejects if `action` returns a promise that rejects or if an error is thrown anywhere.

#### condition

Type: `Function`
Arguments: The value the `action` function returns or `initialValue` for the first iteration.

Expected to return a `boolean` or a `Promise<boolean>` that indicates whether to execute `action`.

#### action

Type: `Function`
Arguments: The value the last call to `action` function returns.

Action to run for each iteration.

You can return a promise and it will be handled.

## Related

- [p-do-whilst](https://github.com/sindresorhus/p-do-whilst) - Calls a function repeatedly while a condition returns true and then resolves the promise
- [p-forever](https://github.com/sindresorhus/p-forever) - Run promise-returning & async functions repeatedly until you end it
- [p-wait-for](https://github.com/sindresorhus/p-wait-for) - Wait for a condition to be true
- [More…](https://github.com/sindresorhus/promise-fun)

---
_Source: https://npm.io/package/p-whilst · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._