react 0.2.5 → 0.3.5

package/README.md

@@ -1,13 +1,8 @@
 # React.js
 
-React is a javascript module to make it easier to work with asynchronous code,
-by reducing boilerplate code and improving error and exception handling while
-allowing variable and task dependencies when defining flow. This project is
-applying the concepts of Reactive programming or Dataflow to controlling
-application flow.
+React is a javascript module to make it easier to work with asynchronous code, by reducing boilerplate code and improving error and exception handling while allowing variable and task dependencies when defining flow. This project is applying the concepts of Reactive programming or Dataflow to controlling application flow.
 
-This async flow control module is initially designed to work with Node.js but
-is planned to be extended to browser and other environments.
+This async flow control module is initially designed to work with Node.js but is planned to be extended to browser and other environments.
 
 React gets its name from similarities with how "chain reactions" work in the physical world. You start the reaction and then it cascades and continues until complete.
 
@@ -40,8 +35,8 @@ It takes inspiration from several projects including:
  - object instance method calls
  - class method calls
  - selectFirst flow where the first task that returns defined, non-null value is used
- - (planned) promise style functions - also automatic resolution of promise inputs
- - (planned) use of resulting flow function as callback style or promise style (if no callback provided)
+ - promise style functions - also automatic resolution of promise inputs (optional require('react/promise-resolve');)
+ - use of resulting flow function as callback style or promise style (if no callback provided) (provided via plugin corresponding to the promise library used)
  - (planned) iteration on arrays, streams, sockets
  - (planned) event emitter integration
 
@@ -49,7 +44,8 @@ The tasks can be mixed, meaning you can use async, sync, object method calls, cl
 
 ## Concept
 
-Borrowing heavily from Tim and Elijah's ideas for conductor, this async flow control module provides a way to construct a flow from a collection of functions or methods (referred to as _tasks_ in this module). It allows dependencies to be defined between the tasks so they can run in parallel as their dependencies are satisfied. React can us both variable dependencies and task dependencies.
+Borrowing heavily from Tim and Elijah's ideas for conductor, this async flow control module provides a way to construct a flow from a
+collection of rules based on functions or methods (referred to as _tasks_ in this module). It allows dependencies to be defined between the tasks so they can run in parallel as their dependencies are satisfied. React can us both variable dependencies and task dependencies.
 
 As tasks complete, React watches the dependencies and kicks off additional tasks that have all their dependencies met and are ready to execute. This allows the flow to run at maximum speed without needing to arbitrarily block tasks into groups of parallel and serial flow.
 
@@ -57,11 +53,12 @@ To reduce the boilerplate code needed and improve error handling, React automati
 
  1. check for error and handle by calling outer callback function with this error after augmenting it with additional context information for easier debugging
  2. save the callback variables into a context for future reference
- 3. call back into React (and it will kick off additional tasks that are now ready to go)
+ 3. call back into React (and it will kick off additional tasks that  are now ready to go)
+ 4. Using the dependencies specified for each
 
 ## Design
 
- - Parse and validate DSL rules at module load time
+ - Parse and validate DSL rules at module load time creating AST
  - Validate the flow AST at module load time - determine if dependencies can all be met as defined
  - Execute the flow AST by calling the function with arguments
 
@@ -75,11 +72,10 @@ Pull from github - http://github.com/jeffbski/react
 
 ## Examples
 
- 1. [Default DSL](#defaultDSL)
- 2. [Direct AST](#directAST)
- 3. [Using pseudocode DSL](#pcode)
- 4. [Using jquery-like chaining DSL](#chain)
+ 1. [Direct AST](#directAST)
+ 2. [Default DSL](#defaultDSL)
 
+### Example using the default DSL
 
 These live in the examples folder so they are ready to run.
 Also see test/module-use.test.js for more examples as well
@@ -88,40 +84,63 @@ as the specific tests for the DSL you want to use.
 <a name="defaultDSL"/>
 ### Example using default DSL
 
+ - Simple example showing flow definition of two async functions feeding a
+   synchronous function.
+
+ - First two async functions inputs are satisfied by the flow inputs, so
+   they will both run immediately in parallel.
+
+ - The last function waits for the outputs of the previous ones, then
+   executes synchronously.
+
+ - Finally the flow calls the callback with the output values once all
+   the tasks have completed.
+
 ```javascript
-// in your foo module
+// in your foobar module
 var react = require('react');
 
 // some normal async and sync functions
-function loadUser(uid, cb){ }
-function loadFile(filename, cb){ }
-function markdown(filedata) { }
-function writeOutput(html, user, cb){  }
-function loadEmailTemplate(cb) { }
-function customizeEmail(user, emailHtml, cb) { }
-function deliverEmail(custEmailHtml, cb) { }
+function loadFoo(fooPath, cb) {
+  setTimeout(function () {
+    cb(null, [fooPath, 'data'].join(':'));
+  }, 10);
+}
+
+function loadBar(barPath, barP2, cb) {
+  setTimeout(function () {
+    cb(null, [barPath, barP2, 'data'].join(':'));
+  }, 10);
+}
+
+function render(foo, bar) {
+  return ['<html>', foo, '/', bar, '</html>'].join('');
+}
 
 // define fn, glue together with react, it will parallelize
 // starts with name and in/out params, then the tasks
-var loadAndSend = react('loadAndSend', 'uid, filename, cb -> err, user',
-  loadUser, 'uid, cb -> err, user',
-  loadFile, 'filename, cb -> err, filemd',
-  markdown, 'filemd -> html',  // no cb, implies sync fn
-  writeOutput, 'html, user, cb -> err, htmlBytesWritten',
-  loadEmailTemplate, 'cb -> err, emailmd',
-  markdown, 'emailmd -> emailHtml',  // no cb, implies sync fn
-  customizeEmail, 'user, emailHtml, cb -> err, custEHtml',
-  deliverEmail, 'custEHtml, cb -> err, custBytesWritten'
+var loadRender = react('loadRender', 'fooPath, barPath, barP2, cb -> err, renderedOut',
+  loadFoo, 'fooPath, cb -> err, foo',    // async cb function
+  loadBar, 'barPath, barP2, cb -> err, bar',  // async cb function
+  render, 'foo, bar -> renderedOut'  // sync function using outputs from first two
 );
-exports.loadAndSend = loadAndSend; // is a normal fn created by react
+
+exports.loadRender = loadRender;  // is a normal fn created by react
+
 
 // in a different module far far away, use this as any other node function
-var foo = require('foo');
-foo.loadAndSend(100, 'bar.md', function (err, user) {
-  // tasks were parallelized based on their depedencies
-}
+var foobar = require('foobar');
+foobar.loadRender('foo.txt', 'bar.txt', 'BBB', function (err, renderedOut) {
+  // tasks in loadRender were parallelized based on their input dependencies
+  console.error('results:', renderedOut);
+});
 ```
 
+Below is a graph of how the dependencies are mapped by React which
+also indicates how the tasks will be executed
+
+![default-simple.dot.png](https://github.com/jeffbski/react/raw/master/doc/default-simple.dot.png)
+
 
 <a name="directAST"/>
 ### Example directly using AST
@@ -153,95 +172,147 @@ fn('foo', 'pre-', '-post', function cb(err, lres) {
 });
 ```
 
-<a name="fstr"/>
-### Example using Function String DSL interface
+### Alternate interfaces (DSL's)
+
+ 1. [Using pseudocode DSL](https://github.com/jeffbski/react/blob/master/doc/alternate-dsls.md#pcode)
+ 2. [Using jquery-like chaining DSL](https://github.com/jeffbski/react/blob/master/doc/alternate-dsls.md#chain)
+ 3. [Using function string DSL](https://github.com/jeffbski/react/blob/master/doc/alternate-dsls.md#fstr)
+
+
+## User API
+
+### Default DSL
+
+The main function returned from require('react') can be used to define the AST used for the processing of the rules or flow.
+
+It takes the following arguments to define a flow function:
 
 ```javascript
 var react = require('react');
+var fn = react('my-flow-name', 'paramName1, paramName2, cb -> err, outParamName1, outParamName2',
+  functionRefOrMethodStr, 'paramName1, cb -> err, outParamName2',  // async cb task
+  functionRefOrMethodStr2, 'paramName2, paramName1 -> outParamName1'   // sync task
+);
+```
 
-function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
-function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
-function markdown(filedata) { return 'html'+filedata; }
-function prepareDirectory(outDirname, cb){ setTimeout(cb, 200, null, 'dircreated-'+outDirname); }
-function writeOutput(html, user, cb){  setTimeout(cb, 300, null, html+'_bytesWritten'); }
-function loadEmailTemplate(cb) { setTimeout(cb, 50, null, 'emailmd'); }
-function customizeEmail(user, emailHtml, cb) { return 'cust-'+user+emailHtml; }
-function deliverEmail(custEmailHtml, cb) { setTimeout(cb, 100, null, 'delivered-'+custEmailHtml); }
-
-function useHtml(err, html, user, bytesWritten) {
-  if(err) {
-    console.log('***Error: %s', err);
-    return;
-  }
-  console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
-}
+ 1. **flow/function name** - string - represents the name of the flow or function that will be created. React will use the name when generating events so you can monitor progress and performance and also when errors occur.
+ 2. **in/out flow parameter definition** - string - the inputs and outputs for the flow function. The parameters are specified in one single string for easy typing, separated by commas. The output follows the input after being separated by a `->`. Use the parameter name `cb` or `callback` to specify the Node style callback and `err` to represent the error parameter as the first output parameter of the callback. Literal values can also be specified directly (true, false, numbers, this, null). Literal strings can simply be quoted using single or double quotes.
+ 3. **optional flow options** - object - If an object is provided immediately after the in/out flow def, then these options will be provided to react to customize the flow. This is reserved for future use.
+ 3. **function reference or method string** - Specify the function to be called for this task, or if calling a method off of an object being passed in or returned by a task, use a string to specify like `'obj.method'`. These can be asynchronous Node-style callback `cb(err, ...)` functions or synchronous functions which simply return values directly.
+ 4. **in/out task parameter definition** - string - similar to the in/out flow parameter definition above, these are the inputs and outputs that are passed to a task function and returned from a task function. The inputs will need to match either those from the flow inputs or outputs from other tasks that will run before this task. React will use the inputs as dependencies, so it will invoke and wait for response from the tasks that provide the dependent inputs. So simply by specifying inputs and outputs for the tasks, React will prioritize and parallelize tasks to run as fast as possible. Use `cb` or `callback` along with `err` to specify asynchronous Node style `cb(err, ...)` task, or omit both to specify a synchronous task.A synchronous task can only have a single return parameter.
+ 5. **optional task options** - object - if an object is provided this can be used to specify additional options for this task.  Currently the valid options for a task are:
+   - **name** - string - specifies a name for a task, otherwise React will try to use the function name or method string if it is unique in the flow. If a name is not unique subsequent tasks will have `_index` (zero based index of the task) added to create unique name. If you specify a name, you will also want to indicate a unique name for within the flow otherwise it will get a suffix as well. Example: `{ name: 'myTaskName' }`
+   - **after** - string, function reference, or array of string or function refs - specify additional preconditions that need to be complete before this task can run. In addition to the input dependencies being met, wait for these named tasks to complete before running.  The preconditions are specified using the name of the task or if the task function was only used once and is a named function (not anonymous), you can just provide the function reference and it will determine name from it. Example: `{ after: 'foo' }` or `{ after: ['foo', 'bar'] }`
+ 6. **repeat 3-5** - repeat steps 3-5 to specify additional tasks in this flow. As dependencies are met for tasks, React will invoke additional tasks that are ready to run in the order they are defined in this flow definition. So while the order does have some influence on the execution, it is primarily defined by the input dependencies and any other additonal preconditions specified with the `after` option. If you want to guarantee that something only runs after something else completes, then it will need to use an output from that task or specify the dependency with an `after`.
 
-var loadAndSave = react.fstrDefine('filename, uid, outDirname, cb', [  // input params
-  loadUser,         'uid              -> err, user',     // calling async fn loadUser with uid, callback is called with err and user
-  loadFile,         'filename         -> err, filedata',
-  markdown,         'filedata         -> returns html',    // using a sync function
-  prepareDirectory, 'outDirname       -> err, dircreated',
-  writeOutput,      'html, user       -> err, bytesWritten', { after: prepareDirectory },  // only after prepareDirectory done
-  loadEmailTemplate, '                 -> err, emailmd',
-  markdown,         'emailmd          -> returns emailHtml',   // using a sync function
-  customizeEmail,   'user, emailHtml  -> returns custEmailHtml',
-  deliverEmail,     'custEmailHtml    -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
-], 'err, html, user, bytesWritten');   // callback output params
-
-loadAndSave('file.md', 100, '/tmp/foo', useHtml);  // executing the flow
-```
 
-<a name="pcode"/>
-### Example using pseudocode DSL interface
+The flow function created by react from the input definition is a normal Node-style function which can be used like any other. These flow functions can be defined in a module and exported, they can be passed into other functions, used as methods on objects (the `this` context is passed in and available).
+
+
+### AST
+
+The abstract syntax tree or AST provided by React represents the data necessary to define the flow. By abstracting this from the DSL, it allows new skins or interfaces to be developed without need to change the core engine.
+
+The AST is normally created at parse time when the React main function is called (or one of the alternate DSL's is called). This can be done a module load time such that after loading the React defined flow function's AST is generated and ready to process eliminating parsing and validation overhead when it is invoked in the future. This has the added advantage that since validation has also been performed that additional syntax issues or incomplete flow defintion errors can be caught quickly.
+
+After the flow function has been created, you can review the generated AST for a function by accessing the ast.
 
 ```javascript
 var react = require('react');
+var fn = react('my-flow-name', 'paramName1, paramName2, cb -> err, outParamName1, outParamName2',
+  functionRefOrMethodStr, 'paramName1, cb -> err, outParamName2',  // async cb task
+  functionRefOrMethodStr2, 'paramName2, paramName1 -> outParamName1'   // sync task
+);
 
-function multiply(a, b, cb) { cb(null, a * b); }
-function add(a, b) { return a + b; }
-var locals = {   // since pcodeDefine uses strings, need references to functions passed into react
-  multiply: multiply,
-  add: add
-};
-
-var fn = react.pcodeDefine('a, b, cb', [  // input params
-  'm := multiply(a, b)',   // using a callback function, use :=
-  's = add(m, a)',        // using a sync function, use =
-  'cb(err, m, s)'     // output params for final callback
-], locals);    // hash of functions that will be used
-
-fn(2, 3, function (err, m, s) {
-  console.error('err:', err); // null
-  console.error('m:', m);  // 2 * 3 = 6
-  console.error('s:', s);  // 6 + 2 = 8
-});
+console.error(fn.ast); // output the generated AST
 ```
 
-<a name="chain"/>
-### Example using jquery-like chaining DSL interface
+The AST contains the following pieces:
 
 ```javascript
-var react = require('react');
+  var ast = {
+    name: flowName,
+    inParams: [],
+    tasks: [],
+    outTask: {},
+    locals: {}
+  };
+```
+ - **name** - string - represents the name of the flow or function that will be created. React will use the name when generating events so you can monitor progress and performance and also when errors occur.
+ - **inParams** - array of strings - the flow input parameter names (excluding the callback param)
+ - **tasks** - array of task defintion objects - each containing:
+   - **f** - function reference or method string - async or sync function to be used for this task
+   - **a** - array of input parameter names (excluding the callback param)
+   - **out** - array of output parameter names (excluding the err parame)
+   - **type** - type of function determining how function is invoked and its output style - one of: ('cb', 'ret', 'promise', 'when')
+   - **name** - string - unique name for each task provided or generated by React
+ - **outTask** - task definition object specifying the flow's output style and parameters containing:
+   - **f** - will contain reference to the callback function at runtime
+   - **a** - parameters being passed as output from the flow
+ - **locals** - object provided which contains additional values that will become part of the React variable space like input parameters but can be defined in advance at flow definition. This can be used to provide functions and objects to React enabling string based DSL's like the pcode DSL can be utilized.
 
-function multiply(a, b, cb) { cb(null, a * b); }
-function add(a, b) { return a + b; }
 
-var fn = react.chainDefine()
-  .in('a', 'b', 'cb')                                   // input params
-  .out('err', 'm', 's')                                 // final callback output params
-  .async(multiply).in('a', 'b', 'cb').out('err', 'm')   // task def - async fn, in params, callback out params
-  .sync(add).in('m', 'a').out('s')                      // task def - sync fn, in params, return value
-  .end();
+### Plugins (optional requires which turn on additional functionality)
 
-fn(2, 3, function (err, m, s) {
-  console.error('err:', err); // null
-  console.error('m:', m);  // 2 * 3 = 6
-  console.error('s:', s);  // 6 + 2 = 8
-});
+Additional functionality which is not enabled by default but available by requiring additional modules.
+
+
+#### LogEvents - log react progress to stderr
+
+For convenience in debugging or in monitoring flow and performance, React has a built-in plugin for easily logging progress to stderr which is activiated by requiring it and specifying a particular flow function to log or use the main react for global logging of all react modules.
+
+```javascript
+require('react/lib/log-events').logEvents(react); // turn on logging for all react functions
+
+// OR
+
+require('react/lib/log-events').logEvents(myReactFn); // turn on logging for a specific function, repeat for other functions as needed
+```
+
+#### Automatic Promise Resolution for inputs
+
+If you want to automatically resolve promises in React without having to manually call `when` or `then`, React provides a plugin which will detect the existence of a `then` method (indicating a promise) at runtime from any inputs to the flow and will internally create `when` tasks to resolve them before passing the values to other tasks.
+
+```javascript
+require('react/promise-resolve');
 ```
 
+#### Track tasks
+
+Instead of only logging events to stderr (like LogEvents), this plugin fires events that can be directly monitored. The LogEvent plugin uses this internally to get access to the metrics.
+
+It also provides a simple accumulator which can be used to accumulate events. Note that this accumulator is designed for short term debug use, as it will continue to accumulate events and does not have any size restrictions.
+
+Thus while the tracking can be used in production because it simply fires events, the accumulator should only be used for convenience in debugging and testing.
+
+```javascript
+require('react/lib/track-tasks');  // enable tracking and events
+
+// if you want to use the accumulator
+
+var EventCollector = require('react/lib/track-tasks').EventCollector;
+var collector = new EventCollector();
+
+collector.captureGlobal('*'); // capture all react events for all flows
+
+// OR
+
+collector.capture(flowFn, 'task.'); // capture task events on a flow
+collector.capture(flowFn, 'flow.'); // add capture flow events on a flow
+
+var events = collector.list();  // retrieve the list of events
+```
+
+#### Alternate DSL's
+
+Additional DSL's can be loaded by requiring them. See the [Alternate DSL](https://github.com/jeffbski/react/blob/master/doc/alternate-dsls.md) page for more info.
+
+
 ## Status
 
+ - 2012-01-17 - Additional documentation (v0.3.5)
+ - 2012-01-16 - Refine events and create logging plugin (v0.3.3)
+ - 2012-01-13 - Add promise tasks, promise resolution, refactor alternate DSL interfaces as optional requires (v0.3.0)
  - 2012-01-11 - Provide warning/error when name is skipped in default DSL, literal check in validate (v0.2.5)
  - 2012-01-10 - Create default DSL for react(), create error for missing variables, list remaining tasks when flow won't complete
  - 2011-12-21 - Refactor from ground up with tests, changes to the interfaces
@@ -252,23 +323,27 @@ fn(2, 3, function (err, m, s) {
 ```bash
 ok ast.test.js .................... 10/10
 ok cb-task.test.js ................ 31/31
-ok chain.test.js .................. 56/56
-ok core.test.js ................... 98/98
-ok dsl.test.js .................... 63/63
+ok core-deferred.test.js .......... 11/11
+ok core-promised.test.js .......... 11/11
+ok core-when.test.js ................ 6/6
+ok core.test.js ................. 104/104
+ok chain.test.js .................. 74/74
+ok fstr.test.js ................... 67/67
+ok pcode.test.js .................. 94/94
+ok dsl.test.js .................... 70/70
 ok event-manager.test.js .......... 13/13
 ok exec-options.test.js ............. 3/3
 ok finalcb-task.test.js ............. 5/5
-ok fstr.test.js ................... 64/64
 ok input-parser.test.js ........... 15/15
-ok module-use.test.js ............. 64/64
-ok pcode.test.js .................. 65/65
+ok module-use.test.js ............. 21/21
+ok promise-auto-resolve.test.js ..... 4/4
 ok ret-task.test.js ............... 31/31
 ok task.test.js ..................... 1/1
 ok validate-cb-task.test.js ......... 6/6
 ok validate-ret-task.test.js ........ 7/7
 ok validate.test.js ............... 31/31
-ok vcon.test.js ................... 42/42
-total ........................... 623/623
+ok vcon.test.js ................... 55/55
+total ........................... 692/692
 
 ok
 ```

package/doc/alternate-dsls.md

@@ -0,0 +1,103 @@
+# Alternate DSL's
+
+These DSL's are not loaded by default and thus require a separate require if you want to use one.
+
+Since React is an AST based rules system, it allows custom DSL's to be created easily, they only need to generate the AST and they are fully functional, allowing many different interfaces for the same system.
+
+
+### Examples using the AST directly or alternate DSL's
+
+
+ 1. [Using pseudocode DSL](#pcode)
+ 2. [Using jquery-like chaining DSL](#chain)
+ 3. [Function String DSL](#fstr)  (Deprecated)
+
+
+<a name="pcode"/>
+### Example using pseudocode DSL interface
+
+```javascript
+var pcodeDefine = require('react/dsl/pcode');
+
+function multiply(a, b, cb) { cb(null, a * b); }
+function add(a, b) { return a + b; }
+var locals = {   // since pcodeDefine uses strings, need references to functions passed into react
+  multiply: multiply,
+  add: add
+};
+
+var fn = pcodeDefine('a, b, cb', [  // input params
+  'm := multiply(a, b)',   // using a callback function, use :=
+  's = add(m, a)',        // using a sync function, use =
+  'cb(err, m, s)'     // output params for final callback
+], locals);    // hash of functions that will be used
+
+fn(2, 3, function (err, m, s) {
+  console.error('err:', err); // null
+  console.error('m:', m);  // 2 * 3 = 6
+  console.error('s:', s);  // 6 + 2 = 8
+});
+```
+
+<a name="chain"/>
+### Example using jquery-like chaining DSL interface
+
+```javascript
+var chainDefine = require('react/dsl/chain');
+
+function multiply(a, b, cb) { cb(null, a * b); }
+function add(a, b) { return a + b; }
+
+var fn = chainDefine()
+  .in('a', 'b', 'cb')                                   // input params
+  .out('err', 'm', 's')                                 // final callback output params
+  .async(multiply).in('a', 'b', 'cb').out('err', 'm')   // task def - async fn, in params, callback out params
+  .sync(add).in('m', 'a').out('s')                      // task def - sync fn, in params, return value
+  .end();
+
+fn(2, 3, function (err, m, s) {
+  console.error('err:', err); // null
+  console.error('m:', m);  // 2 * 3 = 6
+  console.error('s:', s);  // 6 + 2 = 8
+});
+```
+
+<a name="fstr"/>
+### Example using Function String DSL interface
+
+The Function String DSL interface is deprecated since it morphed into the default DSL which is very similar. It is recommended that you use the default DSL instead.
+
+```javascript
+var fstrDefine = require('react/dsl/fstr');
+
+function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
+function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
+function markdown(filedata) { return 'html'+filedata; }
+function prepareDirectory(outDirname, cb){ setTimeout(cb, 200, null, 'dircreated-'+outDirname); }
+function writeOutput(html, user, cb){  setTimeout(cb, 300, null, html+'_bytesWritten'); }
+function loadEmailTemplate(cb) { setTimeout(cb, 50, null, 'emailmd'); }
+function customizeEmail(user, emailHtml, cb) { return 'cust-'+user+emailHtml; }
+function deliverEmail(custEmailHtml, cb) { setTimeout(cb, 100, null, 'delivered-'+custEmailHtml); }
+
+function useHtml(err, html, user, bytesWritten) {
+  if(err) {
+    console.log('***Error: %s', err);
+    return;
+  }
+  console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
+}
+
+var loadAndSave = fstrDefine('filename, uid, outDirname, cb', [  // input params
+  loadUser,         'uid              -> err, user',     // calling async fn loadUser with uid, callback is called with err and user
+  loadFile,         'filename         -> err, filedata',
+  markdown,         'filedata         -> returns html',    // using a sync function
+  prepareDirectory, 'outDirname       -> err, dircreated',
+  writeOutput,      'html, user       -> err, bytesWritten', { after: prepareDirectory },  // only after prepareDirectory done
+  loadEmailTemplate, '                 -> err, emailmd',
+  markdown,         'emailmd          -> returns emailHtml',   // using a sync function
+  customizeEmail,   'user, emailHtml  -> returns custEmailHtml',
+  deliverEmail,     'custEmailHtml    -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
+], 'err, html, user, bytesWritten');   // callback output params
+
+loadAndSave('file.md', 100, '/tmp/foo', useHtml);  // executing the flow
+```