flynx/actions.js
1
0
Fork 0
mirror of https://github.com/flynx/actions.js.git synced 2025-10-29 10:20:09 +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:10:59 +03:00
parent c9a45e033b
commit b8b10f8b36
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -13,17 +13,17 @@ Actions are an extension to the JavaScript object model tailored for
a set of specific tasks. a set of specific tasks.
### Goals: #### Goals:
- Provide a unified mechanism to define and manage user API's for - Provide a unified mechanism to define and manage user API's for
use in UI-hooks, keyboard mappings, scripting, ... etc. use in UI-hooks, keyboard mappings, scripting, ... etc.
- A means to generate configuration UI's - A means to generate configuration UI's
- A means to generate documentation - A means to generate documentation
### Restrictions: #### Restrictions:
- **No method shadowing** - **No method shadowing**
The _extending_ action can not "shadow" the _extended_ action in a The _extending_ action can not "shadow" the _extended_ action in a
non destructive manner (e.g. via a throw), all actions in a chain are non destructive manner (e.g. via a `throw`), all actions in a chain are
guaranteed to be called, unless a fatal error condition. guaranteed to be called, unless a fatal error condition.
- **No argument shadowing** - **No argument shadowing**
The _extending_ has access to all the arguments that the user passed The _extending_ has access to all the arguments that the user passed
@ -31,13 +31,18 @@ a set of specific tasks.
them. them.
- **No return shadowing** - **No return shadowing**
The _extending_ action can not replace the object returned by the The _extending_ action can not replace the object returned by the
_extended_ action, though it can _coopiratively_ update/modify it if _extended_ action, though it can _cooperatively_ update/modify it if
needed needed
- **Single return point** - **Single return point**
Only the _root_ action can return a value, any other returns by Only the _root_ action can return a value, any other returns by
_extending_ actions are ignored _extending_ actions are ignored
- The default return value is `this` - The default return value is `this`
By design this tool-set promotes a _cooperative_ design and makes it
hard to change/modify existing signatures / _contracts_ in _extending_
code.
### The main entities: ### The main entities: