https://github.com/royalgarter/sync-es6
How to write in sync (with only generator & yield ES6), based on waitfor-ES6
https://github.com/royalgarter/sync-es6
Last synced: 3 months ago
JSON representation
How to write in sync (with only generator & yield ES6), based on waitfor-ES6
- Host: GitHub
- URL: https://github.com/royalgarter/sync-es6
- Owner: royalgarter
- Created: 2017-05-30T12:06:55.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-31T05:11:06.000Z (over 7 years ago)
- Last Synced: 2025-02-04T14:08:17.365Z (4 months ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## About
The most native and simplest way to write-in-sync in NodeJS
This library is written purely in ES6 without any dependency
Still non-blocking node's event loop
Fully compatible with all other libraries (such as [async](https://www.npmjs.com/package/async))
NEW UPDATE: support Promise call (BETA - document pending) [Example](https://github.com/royalgarter/sync-es6/blob/master/test-promise.js)
## Install
* npm i sync-es6 --save
## Usage
**CALLBACK HELL**:
```javascript
main(callback) {
async_function(arg1, (err, result1) => {
another_async_function(arg2, (err, result2) => {
return callback && callback(null, result1 + result2);
});
});
}
```
**Step 0**: make sure all of your callback functions will be callbacked as "function (err, result) {}" format
* 1st param: error indicated (usually null)
* 2nd param: real return value
**Step 1**: define wraper function as a generator function, and call inside functions in sync
```javascript
function* writeSyncInside(args1, args2) {
let returnValue1 = yield [async_function, arg1];
let returnValue2 = yield [another_async_function, arg2];
return returnValue1 + returnValue2;
}
```
**Step 2**: CALL IT with sync
```javascript
const _sync = require('sync-es6');
_sync(writeSyncInside /*,args1, args2, ... , callback*/);
// optional callback function at last argument, nice to have in case of error occurred
```
### Sample code:
* [See here, it's very short I swear!!!](https://github.com/royalgarter/sync-es6/blob/master/test.js)
### Syntax:
```javascript
let iterator = _sync(runner,args1, args2, ... , finalcallback);
```
* Parameters
* **runner** *(required)*: a generator function OR object ```{generator: function*, isTolerant: boolean}```
* **isTolerant** *(optional, default "false")*: if it's "true", when an error occurred in inside async function (when callback ```return (err)```) the runner will not throw & break to finalcallback (if existed) and just ```return undefined```
* **args** *(optional)*: input params for generator function
* **finalcallback** *(optional)*: catch error & final result for runner, if it's undefined the runner will throw() when error occurred
* Return
* **iterator** *(optional)*: IT'S NOT final result value, just a [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). Normally you wouldn't use it. It has .break(err) method when you want to break from runner function anytime.
```javascript
iterator.break(err) // break exit from inside runner (generator) function.
```
* Parameters
* **err** *(required)*: Error/String/... anything that's not null
### Credit:
I write this library in thanks of Mr.Luciotato that looking into his code help me learn about generator function. I guess that because of he want the wait.for-es6 should be backward compatible with wait.for (ES5) so there something messy if you wall to call multiple async functions inside each others (with the "onComplete" event) OR maybe just I don't know how to use it properly. So I decide to seperate with a little modification to make it easier to use.
* [wait.for-es6](https://www.npmjs.com/package/wait.for-es6)