timeout

![logo][async-url]

terminate if the source yields too slow

[![NPM version][npm-image]][npm-url]
[![Travis Status][travis-image]][travis-url]
[![Travis Status][codecov-image]][codecov-url]

$3

``
yarn add @async-generators/timeout
`


This package's main entry points to a commonjs dist.
The module entry points to a es2015 module dist. Both require native async-generator support, or be down-compiled with a webpack loader.

Api

$3

timeout() returns an iterable that, when iterated, wraps and iterates the source iterable. If the time taken to return next() is greater than ms then an error is thrown to signify timeout.

Example

example.js
`js
const timeout = require("@async-generators/timeout").default;

async function* source() {
yield 1;
await new Promise(r => setTimeout(r, 500));
yield 2;
}

async function main() {
for await (let item of timeout(source(), 250)) {
console.log(item);
}
}

main().catch(console.log);
`

Execute with the latest node.js:

`
node --harmony-async-iteration example.js
`

output:
`
1
Error: timed out
`


Typescript

This library is fully typed and can be imported using:

`ts
import timeout from '@async-generators/timeout');
`

It is also possible to directly execute your properly configured typescript with ts-node:

`
ts-node --harmony_async_iteration example.ts
``

[npm-url]: https://npmjs.org/package/@async-generators/timeout
[npm-image]: https://img.shields.io/npm/v/@async-generators/timeout.svg
[npm-downloads]: https://img.shields.io/npm/dm/@async-generators/timeout.svg
[travis-url]: https://travis-ci.org/async-generators/timeout
[travis-image]: https://img.shields.io/travis/async-generators/timeout/master.svg
[codecov-url]: https://codecov.io/gh/async-generators/timeout
[codecov-image]: https://codecov.io/gh/async-generators/timeout/branch/master/graph/badge.svg
[async-url]: https://github.com/async-generators