# water-fall

> waterfall tool

Latest version **1.2.0** (published 2016-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install water-fall
pnpm add water-fall
yarn add water-fall
bun add water-fall
```

## 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.2.0 |
| Published | 2016-07-26 |
| First published | 2016-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| Author | liu xing |
| Maintainers | lusionx |
| Keywords | async, waterfall |

## Links

- npm: https://www.npmjs.com/package/water-fall
- Repository: https://github.com/lusionx/water-fall
- Homepage: https://github.com/lusionx/water-fall#readme
- Issues: https://github.com/lusionx/water-fall/issues
- npm.io page: https://npm.io/package/water-fall

## Dependencies (2)

- [async](https://npm.io/package/async.md) ^1.5.2
- [lodash](https://npm.io/package/lodash.md) ^3.10.1

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2016-07-26
- 1.1.0 — 2016-04-12
- 1.0.0 — 2016-04-05
- 0.2.0 — 2016-04-01
- 0.1.1 — 2016-04-01
- 0.1.0 — 2016-04-01

## README

water-fall
======================
所有的fn签名都是
```coffee
fn = (hooks, callback) ->
  xxx (err, vv) ->
    hooks.vv = vv
    callback null # 正常情况 顺序执行
#   callback new Error 忽略之后的步骤, 直接进入 exec
```

```coffee
wf = waterFall.create {}
wf.push (hooks, callback) ->
  xxx (err, vv) ->
    return callback err if err
    hooks.vv = vv
    callback err
wf.push (hooks, callback) ->
  console.log hooks.vv # 可以读取上步的结果
  callback()

cond = (hooks) -> hooks.foo
wf.pushIf cond, (hooks, callback) -> # 等效如下的写法
  ...
  callback()
wf.push (hooks, callback) ->
  return callback() if not hooks
  ...
  callback()


wf.parallel [fn1, fn2] # 等效 push(fn1); push(fn2), 但 fn1, fn2 是同时执行, 没有先后顺序, 都正常执行完成后才进入下一步
wf.any [fn1, fn2] # 同时执行fn1, fn2; 只有都 callback err 才会当做出错处理
wf.exec (err, hooks) ->

```

add alias push

run alias exec

parallel alias all

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