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-24 03:14:23 +03:00
parent 7f52af4b94
commit 70b73ba060
1 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -88,8 +88,7 @@ And both objects can be used in the same way as before:
```javascript ```javascript
// Here we mix the two, but either can be used stand-alone as above... var n = mix(N, ExtendedN) // or Object.create(N) or Object.create(ExtendedN)...
var n = mix(N, ExtendedN)
n.value = 3 n.value = 3
@ -132,13 +131,12 @@ n
The _extending_ has access to all the arguments that the user passed The _extending_ has access to all the arguments that the user passed
but can not modify or reformat them before the _extended_ action gets but can not modify or reformat them before the _extended_ action gets
them. them.
- **No return shadowing** - **No return shadowing / Single return point**
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 _cooperatively_ update/modify it if _extended_ action, though it can _cooperatively_ update/modify it if
needed needed.
- **Single return point** Only the _root_ action can return a value, any other returns in chain
Only the _root_ action can return a value, any other returns by are ignored
_extending_ actions are ignored
- **No state transferred via mixin** - **No state transferred via mixin**
The only two things _inherited_ from the object defining the actions The only two things _inherited_ from the object defining the actions
via the mixin methods or `mix` function are properties and actions, via the mixin methods or `mix` function are properties and actions,
@ -220,8 +218,8 @@ Root Action o---|---x
**Notes:** **Notes:**
- there is no way to prevent an action in the chain from - there is no way to prevent an action in the chain from
running, this is by design, i.e. no way to fully shadow. running, this is by design, i.e. no way to fully shadow.
- actions that do not shadow anything are called root actions. - actions that do not shadow anything are called _base_ or _root actions_.
- returns the action set by default (for call chaining), - returns the action set (`this`) by default (for call chaining),
- the base/root action can return any value. - the base/root action can return any value.
**Notes:** **Notes:**
- if undefined is returned, it will be replaced by the - if undefined is returned, it will be replaced by the
@ -230,11 +228,11 @@ Root Action o---|---x
other than that root action's return values are not other than that root action's return values are not
ignored. ignored.
- can consist of two parts: the first is called before the - can consist of two parts: the first is called before the
shadowed action (pre-callback) and the second after (post-callback). shadowed action (_pre-callback_) and the second after (_post-callback_).
- post-callback has access to the return value and can modify it - post-callback has access to the return value and can modify it
but not replace it. but not replace it.
- can be bound to, a-la an event, calling the handlers when it is - can be bound to, a-la an event, calling the handlers when it is
called, called (_see below_),
**Action (event) handler** **Action (event) handler**
@ -450,9 +448,6 @@ Features is a module that helps build _features_ out of sets of actions
and manage sets of features according to external criteria and and manage sets of features according to external criteria and
feature-feature dependencies. feature-feature dependencies.
### Goals:
XXX
### The main entities: ### The main entities: