# sagu

> javascript Async Iteration utilities.

Latest version **0.2.0** (published 2017-06-29) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-06-29 |
| First published | 2017-06-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taketoshi Aono |
| Maintainers | brn |

## Links

- npm: https://www.npmjs.com/package/sagu
- npm.io page: https://npm.io/package/sagu

## Recent versions

- 0.2.0 (latest) — 2017-06-29
- 0.1.0 — 2017-06-26
- 0.0.2 — 2017-06-26
- 0.0.1 — 2017-06-24

## README

# Sagu

Simple Async Generator Utils

Game changer of javascript asynchronous process.  
Sagu convert async callback functions to simple loop.

**Sagu how change async process of javascript?**

### Stream api

**So far**

```javascript
const res = await fetch('http://ex.com/stream');
res.body.pipeTo(new WritableStream({
  write(chunk) {
    console.log("Chunk received", chunk);
  },
  close() {
    console.log("All data successfully read!");
  },
  abort(e) {
    console.error("Something went wrong!", e);
  }
}));
```

**With sagu**

```javascript
for await (const {chunk, ok, done} of stream('http://ex.com/stream', {binary: true})) {
  console.log(chunk.read());
}
```

### Event

**So far**

```javascript
const a = document.querySelector('a');
a.addEventListener('click', e => console.log(e.target.nodeName));
```

**With sagu**
```javascript
const a = document.querySelector('a');
for await (const {event, dispose} of event(a, 'click')) {
  console.log(event.target.nodeName);
}
```

### Socket.IO

**So far**

```javascript
const conn = io('http://www.sample.com/ws');
conn.on('connection', ...);
conn.on('request', ...);
```

**With sagu**
```javascript
for await (const {type, event} of ws('http://www.sample.com/ws', ws)) {
  switch (type) {
    case 'connection':
    ...
    case 'request':
    ...
  }
  ...
}
```

### Polling

**So far**

```javascript
// polling.
async function poll() {
  const res = await fetch('https://sample.com');
  const json = res.json();
  ...
  setTimeout(poll, 1000);
};
poll();
```

**With sagu**
```javascript
// polling
for await (const {ok, response} of poll('https://sample.com', {}, 1000)) {
  const json = await response.json();
  ...
}
```

etc...


#### Sagu convert async callback function to simple loops.


## Install

`npm install sagu --save`

## Import

*ES6*

```javascript
import {
  wait,
  ws
} from 'sagu';
```

*Node*

```javascript
const {
  wait,
  ws
} = require('sagu');
```

*Script*

```html
<script src="<path to sagu>/sagu/dist/index-iife.js"></script>
<script>console.log(sagu.wait)</script>
```

### For rollup users

Use `rollup-plugin-node-resolve` with `module: true`.

### For Webpack or other bundler users

Import normaly.

## Environment

Sagu only works for environment which support asynchronous iterater(for-await-of).  
Now only babel support that feature.  
So now we support only babel transpilation.

### babel config.

```
"babel": {
  "plugins": [
    [
      "transform-runtime",
      {
        "helpers": false,
        "polyfill": false,
        "regenerator": true,
        "moduleName": "babel-runtime"
      }
    ]
  ],
  "presets": [
    "es2015",
    "stage-3"
  ]
}
```

You must specify `stage-3` presets and transform-runtime.  
In detail,see  
[https://github.com/babel/babel/pull/3473](https://github.com/babel/babel/pull/3473)  
[https://github.com/tc39/proposal-async-iteration](https://github.com/tc39/proposal-async-iteration)


## API

See [API](./api.md)

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