# @lexriver/async

> Async methods

Latest version **3.0.3** (published 2026-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lexriver/async
pnpm add @lexriver/async
yarn add @lexriver/async
bun add @lexriver/async
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2026-10-26 |
| First published | 2020-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 26.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | LexRiver |
| Maintainers | lexriver |
| Keywords | async, wait, await, timeout, pause |

## Links

- npm: https://www.npmjs.com/package/@lexriver/async
- Repository: https://github.com/LexRiver/async
- Homepage: https://github.com/LexRiver/async#readme
- Issues: https://github.com/LexRiver/async/issues
- npm.io page: https://npm.io/package/@lexriver/async

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@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

## Recent versions

- 3.0.3 (latest) — 2026-10-26
- 3.0.2 — 2026-10-26
- 3.0.1 — 2024-09-25
- 3.0.0 — 2024-09-25
- 2.1.3 — 2022-01-27
- 2.1.2 — 2022-01-24
- 2.1.1 — 2022-01-24
- 2.1.0 — 2022-01-24
- 2.0.0 — 2022-01-23
- 1.0.0 — 2020-09-19

## README

# Async

This package provides `Async.waitMsAsync`, `Async.waitForFunctionToReturnTrueAsync` functions and `Lock` class to synchronize flow.

## Install

`npm install @lexriver/async`

## Import

```typescript
import {Async, Lock} from '@lexriver/async'
```

## Methods


### Async.waitMsAsync(millisecondsToWait: number)

Wait for some milliseconds by setTimeout wrapped in Promise

```typescript
await Async.waitMsAsync(500) // wait 500 milliseconds
```

<br/>
<br/>

### Async.waitForFunctionToReturnTrueAsync(functionToReturnTrue: () => boolean, msStep: number = 50, maxMsToWait: number = 0)

Wait for function to return true or throw error

__Parameters__
* `functionToReturnTrue: () => boolean` - function that will be executed on each step
* `msStep?: number` - pause between each steps in milliseconds, default value is 50
* `maxMsToWait?: number` - maximum milliseconds to wait for all steps. Use 0 to wait forever. default values is 0.

```typescript
// waiting for function getTheAnswer() to return 42 checking every 100ms for 1 second total
await Async.waitForFunctionToReturnTrueAsync(() => getTheAnswer() === 42, 100, 1000)
```

<br/>
<br/>

### Lock

Use `Lock` to synchronize async functions flow. So one function will wait for other function to release the lock.

A `Lock` is not reentrant. An action must not acquire the same lock again. Immediate nested acquisition is rejected with an error instead of waiting forever; because JavaScript has no portable async-call-context API, code that attempts the nested acquisition after an `await` should also set `maxMsToWait` as a safeguard. Independent callers continue to queue normally.

```typescript

async function functionWithLock1Async(lock:Lock){
    console.log('(1) start')
    await lock.lockAndExecuteAsync(async () => {
        console.log('(1) function with lock begin...')
        await Async.waitMsAsync(1000) // just wait
        console.log('(1) function with lock end')
    })
    console.log('(1) finish')
}

async function functionWithLock2Async(lock:Lock){
    console.log('(2) start')
    await lock.lockAndExecuteAsync(async () => {
        console.log('(2) function with lock begin...')
        await Async.waitMsAsync(1500) // just wait
        console.log('(2) function with lock end')
    })
    console.log('(2) finish')
}

async function startAsync(){
    const lock = new Lock()

    void functionWithLock1Async(lock) // no await
    void functionWithLock2Async(lock) // no await

    await Async.waitMsAsync(3000)

})
```

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