flynx/actions.js
1
0
Fork 0
mirror of https://github.com/flynx/actions.js.git synced 2025-10-31 11:20:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

working on docs..

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2016-08-23 18:28:06 +03:00
parent b8b10f8b36
commit 92ff8fd4dc
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -20,6 +20,20 @@ a set of specific tasks.
- A means to generate documentation
#### Functionality:
- **Call _extended_ actions automatically**
All actions (methods) in a chain are guaranteed to get called if the
action is called.
- **Thread arguments up the call chain**
All actions in a chain will get the set of arguments passed to the
action when called.
- **Thread the return value down the call chain**
The return value will get passed through all the actions in a chain
before returning to the action caller.
- **Unified way to document actions**
- **Introspection and inspection API**
#### Restrictions:
- **No method shadowing**
The _extending_ action can not "shadow" the _extended_ action in a
@ -36,7 +50,7 @@ a set of specific tasks.
- **Single return point**
Only the _root_ action can return a value, any other returns by
_extending_ actions are ignored
- The default return value is `this`
- **Return `this` by default**
By design this tool-set promotes a _cooperative_ design and makes it
hard to change/modify existing signatures / _contracts_ in _extending_