@seneca/traverse

> _Seneca Traverse_ is a plugin for Seneca

Data Traverse plugin for the Seneca framework.


| !Voxgig | This open source module is sponsored and supported by Voxgig. |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------- |

Install

``sh
$ npm install @seneca/traverse
`

Quick Example

`js
seneca.use('Traverse', {})

const depsRes = await seneca.post('sys:traverse,find:deps')
// === { ok: true, deps: [['foo/bar0,foo/bar1'],...] }
`

More Examples

Review the unit tests for more examples.

Options

* debug : boolean
* rootExecute : boolean
* rootEntity : string
* relations : object
* customRef : object
* init$ : boolean

Action Patterns

* sys:traverse,do:create,on:run
* sys:traverse,do:execute,on:task
* sys:traverse,do:next,on:task
* sys:traverse,do:start,on:run
* sys:traverse,do:stop,on:run
* sys:traverse,find:children
* sys:traverse,find:deps

Action Descriptions

$3

Create a run process and generate tasks for each child entity to be executed.


#### Parameters


* __rootEntity__ : _string_ (optional, default: )
* __rootEntityId__ : _string_
* __taskMsg__ : _string_


----------


$3

Execute a single Run task.


#### Parameters


* __task__ : _object_


----------


$3

No description provided.


#### Parameters


* __runId__ : _string_


----------


$3

Start a Run process execution, dispatching the next pending child task.


#### Parameters


* __runId__ : _string_


----------


$3

Stop a Run process execution, preventing the dispatching of the next pending child task.


#### Parameters


* __runId__ : _string_


----------


$3

Returns all discovered child instances with their parent relationship.


#### Parameters


* __rootEntity__ : _string_ (optional, default: )
* __rootEntityId__ : _string_


----------


$3

Returns a sorted list of entity pairs starting from a given entity.


#### Parameters


* __rootEntity__ : _string_ (optional, default: `)

----------

Motivation

Support

API

Contributing

Background