# @byungi/p-delay

> A delayed promise.

Latest version **0.2.0** (published 2019-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @byungi/p-delay
pnpm add @byungi/p-delay
yarn add @byungi/p-delay
bun add @byungi/p-delay
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2019-12-28 |
| First published | 2019-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 8 |
| Dependencies | 2 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | skt-t1-byungi |
| Maintainers | skt-t1-byungi |
| Keywords | promise, delay, sleep, wait, setTimeout |

## Links

- npm: https://www.npmjs.com/package/@byungi/p-delay
- Repository: https://github.com/skt-t1-byungi/promise/tree/master/packages/p-delay
- npm.io page: https://npm.io/package/@byungi/p-delay

## Dependencies (2)

- [@byungi/p-class](https://npm.io/package/@byungi/p-class.md) ^0.2.0
- [@byungi/promise-helpers](https://npm.io/package/@byungi/promise-helpers.md) ^0.2.0

## 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

- 0.2.0 (latest) — 2019-12-28
- 0.1.3 — 2019-09-21
- 0.1.2 — 2019-03-10
- 0.1.1 — 2019-03-09
- 0.1.0 — 2019-03-09
- 0.0.3 — 2019-01-21
- 0.0.2 — 2019-01-21
- 0.0.1 — 2019-01-15

## README

# @byungi/p-delay
A delayed promise.

## Example
```js
import pDelay from '@byungi/p-delay';

(async() => {
    await pDelay(500)

    console.log('Runs after 500ms.')
})()
```

## API
### pDelay(ms)
Create a delayed promise.

### promise.clear()
Clears the set timer and resolves promise.

```js
const delayPromise = pDelay(500)

setTimeout(()=>{
    delayPromise.clear() //delayPromise is resolved after 200ms.
}, 200)
```

## License
MIT

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