@@ -39,10 +39,11 @@ possible to bundle steps in a flow. From the outside the flows acts as a single
3939### Table of Contents
4040
4141- [ Flow] ( #flow )
42- - [ createEndpoints] ( #createendpoints )
43- - [ endpointFor] ( #endpointfor )
44- - [ connectEndpoints] ( #connectendpoints )
45- - [ connectRootEndpoints] ( #connectrootendpoints )
42+ - [ createEndpoints] ( #createendpoints )
43+ - [ endpointFor] ( #endpointfor )
44+ - [ connectEndpoints] ( #connectendpoints )
45+ - [ connectRootEndpoints] ( #connectrootendpoints )
46+ - [ name] ( #name )
4647- [ willBeUnregistered] ( #willbeunregistered )
4748
4849## Flow
@@ -51,13 +52,16 @@ possible to bundle steps in a flow. From the outside the flows acts as a single
5152
5253This is the flow implementation.
5354It holds all the steps.
55+ Declares the following properties:
56+ \- steps
57+ \- autostart
5458
5559** Parameters**
5660
57- - ` config `
58- - ` owner `
61+ - ` config ` {Object} The definition used to create the flow
62+ - ` owner ` {Object} owner of the flow
5963
60- ## createEndpoints
64+ ### createEndpoints
6165
6266The flow has no real endpoints. It only has proxies.
6367So just return the configuration
@@ -66,7 +70,7 @@ So just return the configuration
6670
6771- ` stepDefinition ` ** [ Object] ( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object ) ** The step configuration
6872
69- ## endpointFor
73+ ### endpointFor
7074
7175Find endpoint for given expression
7276
@@ -78,20 +82,24 @@ Find endpoint for given expression
7882
7983Returns ** Endpoint** found endpoint
8084
81- ## connectEndpoints
85+ ### connectEndpoints
8286
8387set the target endpoints
8488
8589** Parameters**
8690
8791- ` stepDefinition `
8892
89- ## connectRootEndpoints
93+ ### connectRootEndpoints
9094
9195A flow has only endpoint proxies. These will be replaced by the original endpoints
9296of the sub steps
9397get the original endpoints for the Flow.
9498
99+ ### name
100+
101+ Returns ** [ string] ( https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String ) ** 'kronos-flow'
102+
95103## willBeUnregistered
96104
97105Deletes a flow from the stored flow definitions. If the flow
0 commit comments