#6 Updating documentation

Author: mavarazy

README.md

@@ -422,6 +422,53 @@ let rules = [{
 
 Rules engine will go through all the elements in the array and trigger `require` if `any` of the elements meet the criteria.
 
+## Events
+
+Framework does not put any restrictions on event object, that will be triggered, in case conditions are meet
+
+For example, `event` can be a string:
+```js
+let rules = [{
+    conditions: { ... },
+    event: "require"
+}]
+```
+Or number
+```js
+let rules = [{
+    conditions: { ... },
+    event: 4
+}]
+```
+
+Or an `object`
+```js
+let rules = [{
+    conditions: { ... },
+    event: { 
+      type: "require",
+      params: { fields: [ "state" ]}
+    }
+}]
+```
+
+You can even return an array of events, each of which will be added to final array of results
+```js
+let rules = [{
+    conditions: { ... },
+    event: [
+      { 
+        type: "require",
+        params: { field: "state"}
+      },
+      { 
+        type: "remove",
+        params: { fields: "fake" }
+      },
+    ]
+}]
+```
+
 ## License
 
 The project is licensed under the Apache Licence 2.0.

test/applicableActions.eventArray.test.js

@@ -1,18 +1,26 @@
 import applicableActions from "../src/applicableActions";
 
-let rules = [
-  {
-    conditions: {
-      address: "empty",
-    },
-    event: [{ type: "remove" }, { type: "add" }],
-  },
-];
-
 test("check nested fields work", function() {
+  let rules = [
+    {
+      conditions: { address: "empty" },
+      event: [{ type: "remove" }, { type: "add" }],
+    },
+  ];
   expect(applicableActions(rules, {})).toEqual([
     { type: "remove" },
     { type: "add" },
   ]);
   expect(applicableActions(rules, { address: { line: "some" } })).toEqual([]);
 });
+
+test("check fields of different types", function() {
+  let rules = [
+    {
+      conditions: { address: "empty" },
+      event: ["remove", 1],
+    },
+  ];
+  expect(applicableActions(rules, {})).toEqual(["remove", 1]);
+  expect(applicableActions(rules, { address: { line: "some" } })).toEqual([]);
+});