# delayer

> Create a cancellable promise that will be resolved in a specified amount of time.

Latest version **3.0.0** (published 2016-12-01) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install delayer
pnpm add delayer
yarn add delayer
bun add delayer
```

Provides the command `delayer`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2016-12-01 |
| First published | 2015-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Sean Genabe |
| Maintainers | seangenabe |
| Keywords | promise, delay, timeout, cli |

## Links

- npm: https://www.npmjs.com/package/delayer
- Repository: https://github.com/seangenabe/delayer
- Issues: https://github.com/seangenabe/delayer/issues
- npm.io page: https://npm.io/package/delayer

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2016-12-01
- 2.0.0 — 2016-02-29
- 1.0.1 — 2015-07-28
- 1.0.0 — 2015-07-25

## README

# delayer

Create a cancellable promise that will be resolved in a specified amount of time.

[![npm](https://img.shields.io/npm/v/delayer.svg?style=flat-square)](https://www.npmjs.com/package/delayer)
[![Build Status](https://img.shields.io/travis/seangenabe/delayer/master.svg?style=flat-square)](https://travis-ci.org/seangenabe/delayer)
[![devDependency Status](https://img.shields.io/david/dev/seangenabe/delayer.svg?style=flat-square)](https://david-dm.org/seangenabe/delayer#info=devDependencies)
[![node](https://img.shields.io/node/v/delayer.svg?style=flat-square)](https://nodejs.org/en/download/)

## API

```javascript
const Delayer = require('delayer')

// example usage
let d = new Delayer(1000)
d.then(onFulfilled, onRejected)
```

On supported environments, `Delayer` extends from `Promise` but returns `Promise` objects from `Promise.prototype` methods.

The weird stuff that led to this disconnect include:
* [`Promise[Symbol.species]`](http://kangax.github.io/compat-table/es6/#test-Promise_Promise[Symbol.species]) - node.js 6.5; Chrome 51

### Constructor

```javascript
let d = new Delayer(delay)
```

Creates a new instance of `Delayer` which creates an associated promise, which either resolves after the specified amount of time or rejects when `cancel` is called.

On supported environments, the associated promise is equivalent to the `Delayer` instance. On older environments, the associated promise is hidden; `Promise` prototype methods are proxied to the promise, making the instance a valid thenable.

Parameters:
* `delay`: The amount of time to delay, in milliseconds.

### `d.delay`

The delay passed to the constructor.

### `d.cancel()`

Cancels the delayed promise. This will put the promise in a rejected state.

## CLI

```bash
delayer [delay]
```

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