harcon-flow - npm Package Compare versions

Comparing version 2.1.1 to 2.2.0

lib/FlowParser.js

@@ -45,2 +45,7 @@ var Proback = require('proback.js')
 
+	if ( def.startsWith('*') ) {
+		res.foreach = true
+		def = def.substring( 1 )
+	}
+
 	let seps = def.split('|')
@@ -47,0 +52,0 @@ if ( seps.length > 1 ) {

package.json

 {
   "name": "harcon-flow",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Small utility library to descript business flows for harcon",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -22,2 +22,3 @@ Harcon-flow is a simple utility library aiming to leverage a very simple syntax to define microtransaction between entities.
 
+The following section tries to formalise the structure of flow defitions.
 
@@ -29,11 +30,23 @@
 ['->'] actor [ ':' message ] control_flow
-	actor : message
-	// more actor : message lines
+	message
+	// another message
 ```
 
-The first optional mark signs that the given actor is initiated from a REST or websocket call. That will make the actor implicitly a REST-, and Websocket-compliant.
-Then you define the name of the actor, the message its receives and the flow control it represents and finally all the messages it sends out.
+The first optional mark signs that the given actor is initiated from a REST or websocket call.
+That will make the actor implicitly a REST-, and Websocket-compliant.
+Then you define the name of the actor, the message its receives and the type of the [flow control](#control_flow) it represents and finally all the messages it sends out.
 
+message:
 
+```javascript
+'[' workflow name ']'
+or
+['*'] [domain '|'] [ interface ] actor : message
+```
 
+The optional '*' sign means, that the result of the flow's main actor will be interpreted as array and for all elements that given message will be sent to as a bulk operation.
+
+Domain and interface specifications are optional. These information should be defined here only if no Flow definition exists assosiated to the given actor.
+
+
 #### Control flow
@@ -66,3 +79,3 @@
 
-One of the signs can be places before any actors in the definition as follows:
+One of those signs can be places before any actors in the definition as follows:
 
@@ -69,0 +82,0 @@ ```javascript

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19395

increased by3.3%

Lines of code

383

increased by1.06%

Number of lines in readme file

179

increased by7.83%

No dependency changes