# @koax/timing

> Delay, timeout, and interval effects.

Latest version **0.1.2** (published 2016-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @koax/timing
pnpm add @koax/timing
yarn add @koax/timing
bun add @koax/timing
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2016-02-12 |
| First published | 2016-02-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | koax |

## Links

- npm: https://www.npmjs.com/package/@koax/timing
- Repository: https://github.com/koaxjs/timing
- Homepage: https://github.com/koaxjs/timing#readme
- Issues: https://github.com/koaxjs/timing/issues
- npm.io page: https://npm.io/package/@koax/timing

## Dependencies (1)

- [@koax/fork](https://npm.io/package/@koax/fork.md) ^0.1.3

## Recent versions

- 0.1.2 (latest) — 2016-02-12
- 0.1.1 — 2016-02-12

## README

# timing

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Delay, timeout, and interval effects. (Included in koax)

## Installation

    $ npm install @koax/timing

## Usage

```js
import {delay, timeout, interval} from '@koax/timing'

function * () {
  yield delay(500)
  // do something later
}

function * () {
  yield timeout(doSomethingLater, 500)
  // do something now
}

function * () {
  let task = yield interval(repeatSomething, 500)
  // do something and then cancel
  yield cancel(task)
}

```

## API

### delay(wait)

- `wait` - time to block

**Returns:** delay action

### timeout(fn, wait)

- `fn` - function to run after `wait` ms
- `wait` - time to wait

**Returns:** timeout action

### interval(fn, wait)

- `fn` - function to run on an interval
- `wait` - time in between runs

**Returns:** interval action

## License

MIT

[travis-image]: https://img.shields.io/travis/koaxjs/timing.svg?style=flat-square
[travis-url]: https://travis-ci.org/koaxjs/timing
[git-image]: https://img.shields.io/github/tag/koaxjs/timing.svg?style=flat-square
[git-url]: https://github.com/koaxjs/timing
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@koax/timing.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@koax/timing

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