# flowmaster

> A simple module that helps you to manage asynchronous operations in Node.js

Latest version **1.1.0** (published 2015-12-21) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-12-21 |
| First published | 2015-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adebowale Akinola |
| Maintainers | waleakinola |

## Links

- npm: https://www.npmjs.com/package/flowmaster
- Repository: https://github.com/walen007/FlowMaster
- Homepage: https://github.com/walen007/FlowMaster#readme
- Issues: https://github.com/walen007/FlowMaster/issues
- npm.io page: https://npm.io/package/flowmaster

## Recent versions

- 1.1.0 (latest) — 2015-12-21
- 1.0.1 — 2015-12-20
- 1.0.0 — 2015-12-20

## README

A simple module that helps you to manage asyncronous operations and 
avoid callback hell, code smell or spaghetti code.

To run a test, please install the dependencies as follows:
------------------------------------------------------------
<strong>sudo npm install</strong> <br />
<strong>sudo npm install -g mocha</strong>

Run the "mocha" command to test the module.
---------------------------------------------
<strong>mocha</strong>


NB: You must have MongoDB running locally. The test wasn't configured to
use MongoDB connection authentication. You can add authentication on
line 115 of FlowMasterSpec.js, the test file can be found inside the 
"test" folder.


Although this module's test uses MongoDB database asyncronous operations,
the module does not have to be used to manage only async db ops. You 
can use it to manage any type of asyncronous operations in Node.js.

If any functions supplied to the FlowMaster.series() returns an error,
the entire operation is aborted.

Ensure that your functions return acceptable callback formats when using
FlowMaster.series().


Callback format for failed operations:
----------------------------------------
callback(err, {status: 'failed', message: 'YOUR_ERROR_MESSAGE'});


Callback format for successful operations:
--------------------------------------------
callback(null, {status: 'success', message: 'YOUR_SUCCESS_MESSAGE', 
  data: yourResponseData});

More examples can be found in the test file:
/test/FlowMasterSpec.js

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