# sleep-promise

> Resolves a promise after a specified delay

Latest version **9.1.0** (published 2021-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install sleep-promise
pnpm add sleep-promise
yarn add sleep-promise
bun add sleep-promise
```

## Health

**Score 45/100 (D)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 9.1.0 |
| Published | 2021-01-06 |
| First published | 2015-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 433.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 89 |
| Author | Jan Brummelte |
| Maintainers | brummelte |
| Keywords | sleep, promise, delay |

## Links

- npm: https://www.npmjs.com/package/sleep-promise
- Repository: https://github.com/brummelte/sleep-promise
- Issues: https://github.com/brummelte/sleep-promise/issues
- npm.io page: https://npm.io/package/sleep-promise

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

- 9.1.0 (latest) — 2021-01-06
- 9.0.1 — 2021-01-06
- 9.0.0 — 2020-10-18
- 8.0.1 — 2018-06-06
- 8.0.0 — 2018-06-06
- 7.1.0 — 2018-06-05
- 7.0.0 — 2018-06-05
- 6.0.0 — 2018-04-14
- 5.1.0 — 2018-04-11
- 5.0.0 — 2018-04-11
- 4.1.0 — 2018-04-08
- 4.0.0 — 2018-04-08
- 3.0.0 — 2018-04-07
- 2.0.0 — 2016-07-30
- 1.0.0 — 2015-08-22

## README

# sleep-promise [![License][license-image]][license-url] [![NPM version][npm-image]][npm-url] [![NPM downloads][npm-downloads-image]][npm-downloads-url] [![Build][build-image]][build-url] [![Coverage][coverage-image]][coverage-url]

_sleep-promise_ resolves a promise after a specified delay.

## Installation

### node.js

    npm install sleep-promise

## Usage async / await

```javascript
import sleep from 'sleep-promise';

(async () => {
    await sleep(2000);
    console.log('2 seconds later …');
})();
```

## Usage ES5

```javascript
var sleep = require('sleep-promise');

sleep(2000).then(function() {
    console.log('2 seconds later …');
});
```

## Usage in a promise chain

```javascript
import sleep from 'sleep-promise';

let trace = value => {
    console.log(value);
    return value;
};

sleep(2000)
    .then(() => 'hello')
    .then(trace)
    .then(sleep(1000))
    .then(value => value + ' world')
    .then(trace)
    .then(sleep(500))
    .then(value => value + '!')
    .then(trace);

// [2 seconds sleep]
// hello
// [1 second sleep]
// hello world
// [500 ms sleep]
// hello world!
```

## Usage in a test file that mocks setTimeout

```javascript
import sinon from 'sinon';
import sleep from 'sleep-promise';

const clock = sinon.useFakeTimers();

(async () => {
    // 2 seconds faked by sinon
    const sleepPromise = sleep(2000);
    clock.tick(2000);
    await sleepPromise;
    console.log('instant');

    // Caches global setTimeout before sinon replaced it
    const sleepPromise2 = sleep(2000, { useCachedSetTimeout: true });
    clock.tick(2000);
    await sleepPromise2;
    console.log('2 seconds later');
})();
```

## License

[MIT](LICENSE.md)

[license-image]: https://img.shields.io/github/license/brummelte/sleep-promise.svg
[license-url]: https://github.com/brummelte/sleep-promise/blob/master/LICENSE.md
[npm-image]: https://img.shields.io/npm/v/sleep-promise.svg
[npm-url]: https://www.npmjs.com/package/sleep-promise
[npm-downloads-image]: https://img.shields.io/npm/dm/sleep-promise.svg
[npm-downloads-url]: https://www.npmjs.com/package/sleep-promise
[build-image]: https://img.shields.io/circleci/project/github/brummelte/sleep-promise/master.svg
[build-url]: https://circleci.com/gh/brummelte/sleep-promise
[coverage-image]: https://img.shields.io/coveralls/github/brummelte/sleep-promise/master.svg
[coverage-url]: https://coveralls.io/github/brummelte/sleep-promise?branch=master

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