Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/francoispqt/itur
Async iterators made easy with generator control flow
https://github.com/francoispqt/itur
async control-flow coroutines generator iterator
Last synced: about 1 month ago
JSON representation
Async iterators made easy with generator control flow
- Host: GitHub
- URL: https://github.com/francoispqt/itur
- Owner: francoispqt
- License: mit
- Created: 2017-10-18T17:51:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-19T16:40:31.000Z (about 7 years ago)
- Last Synced: 2024-09-18T16:18:07.913Z (2 months ago)
- Topics: async, control-flow, coroutines, generator, iterator
- Language: JavaScript
- Homepage:
- Size: 31.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/francoispqt/itur)
[](https://codecov.io/gh/francoispqt/iter)
# Itur
*Async made easy with generator control flow*
```bash
$ npm i --save itur
```
## Basic example
```javascript
const Itur = require('itur')
const main = function*() {
const result = yield Itur.reduce([1,2,3], function*(agg, key, value){
agg += yield Promise.resolve(value)
return agg
}, 0)
console.log(result) // 6
}
Itur.run(main)()
.catch(console.error)
```
## API
### forEach
```javascript
Itur.forEach([1,2,3], function*(key, value) {
yield Promise.resolve(key)
})
```
### map
```javascript
const result = yield Itur.map([1,2,3], function*(key, value) {
return yield Promise.resolve(key)
})
console.log(result) // [0,1,2]
```
### all
```javascript
const result = yield Itur.all([1,2,3], function*(key, value) {
return yield Promise.resolve(key)
})
console.log(result) // [0,1,2]
```
### reduce
```javascript
const result = yield Itur.reduce([1,2,3], function*(agg, key, value) {
agg += yield Promise.resolve(value)
return agg
}, 0)
console.log(result) // 6
```
### find
```javascript
const result = yield Itur.find([1,2,3], function*(agg, key, value) {
return key === yield Promise.resolve(2)
}, 0)
console.log(result) // 3
```
### while
```javascript
let c = 0
Itur.while(
() => c < 10,
function*() {
yield Promise.resolve('do any async')
c++
}
)
```
### range
```javascript
const a = [1,2,3]
const fn = function*(key, value) {
return yield Promise.resolve('foobar')
}
for (const i of Itur.range(a, fn)) {
console.log(i) // foobar
}
```
### Chaining
You can chain certain operations. Example:
```javascript
const result = yield Itur.map([1,2,3], function*(key, value) {
return key + yield Promise.resolve(value)
})
.reduce(function*(agg, key, value) {
agg.push(yield Promise.resolve(value))
return agg
}, [])
.find(function*(key, value) {
return key === 1
})
console.log(result) // 3
```
### Constructor syntax