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

updated docs...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2018-10-04 13:39:02 +03:00
parent bc83cbd9ff
commit 423b79a9af
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -11,9 +11,11 @@ An extensible tree walk(..) framework...
- [Installation and loading](#installation-and-loading) - [Installation and loading](#installation-and-loading)
- [API](#api) - [API](#api)
- [`walk(..)`](#walk) - [`walk(..)`](#walk)
- [`getter(..)`](#getter) - [`getter(..)`](#getter)
- [`done(..)`](#done) - [`done(..)`](#done)
- [Examples](#examples) - [Examples](#examples)
- [Contacts, feedback and contributions](#contacts-feedback-and-contributions)
- [License](#license)
@ -141,7 +143,7 @@ Walk the nodes.
*Note that `state` can not be a function unless `done(..)` is provided.* *Note that `state` can not be a function unless `done(..)` is provided.*
### `getter(..)` #### `getter(..)`
`getter(state, node, next(..), stop(..)) -> state` `getter(state, node, next(..), stop(..)) -> state`
User provided function, called to process a node. `getter(..)` is passed the current `state`, the `node` and two control functions: `next(..)` and `stop(..)` to control the *walk* execution flow. User provided function, called to process a node. `getter(..)` is passed the current `state`, the `node` and two control functions: `next(..)` and `stop(..)` to control the *walk* execution flow.
@ -164,13 +166,12 @@ Stop walking and return `state`. The passed `state` is directly returned from th
*Note that `stop(..)` behaves in a similar manner to `return`, i.e. execution is aborted immidiately.* *Note that `stop(..)` behaves in a similar manner to `return`, i.e. execution is aborted immidiately.*
### `done(..)` #### `done(..)`
`done(state) -> state` `done(state) -> state`
User provided function, if given, is called by the *walker* after walking is done (no more nodes to handle). `state` is passed as argument and the return value is returned from the *walker*. This is run in the same context (`this`) as `getter(..)`. User provided function, if given, is called by the *walker* after walking is done (no more nodes to handle). `state` is passed as argument and the return value is returned from the *walker*. This is run in the same context (`this`) as `getter(..)`.
## Examples ## Examples
Sum all the values of a nested array (breadth-first)... Sum all the values of a nested array (breadth-first)...
@ -254,3 +255,16 @@ firstZero([10, 5, [{x: 1, y: 0}, 4]]) // -> ['2', '0', 'y']
``` ```
## Contacts, feedback and contributions
- https://github.com/flynx/walk.js
- https://www.npmjs.com/generic-walk
- https://github.com/flynx
## License
[BSD 3-Clause License](./LICENSE)
Copyright (c) 2018, Alex A. Naanou,
All rights reserved.