Revert to using "events" object returned from engine for examples

Author: Cache Hamm

CHANGELOG.md

@@ -13,7 +13,7 @@
     * The `success-events` fact used to store successful events has been converted to an internal data structure and will no longer appear in the almanac's facts. (fixes #187)
   * NEW FEATURES
     * Engine constructor now accepts a `pathResolver` option for resolving condition `path` properties. Read more [here](./docs/rules.md#condition-helpers-custom-path-resolver). (fixes #210)
-    * Engine.run() now returns:
+    * Engine.run() now returns three additional data structures:
       * `failureEvents`, an array of all failed rules events. (fixes #192)
       * `results`, an array of RuleResults for each successful rule (fixes #216)
       * `failureResults`, an array of RuleResults for each failed rule

README.md

@@ -86,8 +86,8 @@ let facts = {
 // Run the engine to evaluate
 engine
   .run(facts)
-  .then(({ results }) => {
-    results.map(result => console.log(result.event.params.message))
+  .then(({ events }) => {
+    events.map(event => console.log(event.params.message))
   })
 
 /*
@@ -170,8 +170,8 @@ engine.addFact('account-information', function (params, almanac) {
 let facts = { accountId: 'lincoln' }
 engine
   .run(facts)
-  .then(({ results }) => {
-    console.log(facts.accountId + ' is a ' + results.map(result => result.event.params.message))
+  .then(({ events }) => {
+    console.log(facts.accountId + ' is a ' + events.map(event => event.params.message))
   })
 
 /*

docs/engine.md

@@ -164,22 +164,13 @@ await engine.run()
 // with constant facts
 await engine.run({ userId: 1 })
 
-// results
 const {
-  results,
-  failureResults,
-  events,
-  failureEvents,
-  almanac
+  results,         // rule results for successful rules
+  failureResults,  // rule results for failed rules
+  events,          // array of successful rule events
+  failureEvents,   // array of failed rule events
+  almanac          // Almanac instance representing the run
 } = await engine.run({ userId: 1 })
-
-/**
- * almanac: Almanac instance for the run
- * results: rule results for successful rules
- * failureResults: rule results for failed rules
- * events: successful rule events
- * failureEvents: failed rule events
- */
 ```
 Link to the [Almanac documentation](./almanac.md)
 

docs/walkthrough.md

@@ -138,7 +138,7 @@ engine.on('young-adult-rocky-mnts', (params) => {
 // - OR -
 
 // subscribe to any event emitted by the engine
-engine.on('success', function (event, engine) {
+engine.on('success', function (event, almanac, ruleResult) {
     console.log('Success event:\n', event);
   // event: {
   //   type: "young-adult-rocky-mnts",
@@ -162,8 +162,8 @@ Running an engine executes the rules, and fires off event events for conditions
 engine.run({ userId: 1 });  // any time a rule condition requires 'userId', '1' will be returned
 
 // run() returns a promise
-engine.run({ userId: 4 }).then(({ results }) => {
-  console.log('all rules executed; the following events were triggered: ', results.map(result => JSON.stringify(result.event)))
+engine.run({ userId: 4 }).then(({ events }) => {
+  console.log('all rules executed; the following events were triggered: ', events.map(result => JSON.stringify(event)))
 });
 ```
 Helper methods (for this example)

examples/01-hello-world.js

@@ -47,9 +47,9 @@ async function start () {
   const facts = { displayMessage: true }
 
   // engine.run() evaluates the rule using the facts provided
-  const { results } = await engine.run(facts)
+  const { events } = await engine.run(facts)
 
-  results.map(result => console.log(result.event.params.data.green))
+  events.map(event => console.log(event.params.data.green))
 }
 
 start()

examples/02-nested-boolean-logic.js

@@ -61,9 +61,9 @@ async function start () {
     gameDuration: 40
   }
 
-  const { results } = await engine.run(facts)
+  const { events } = await engine.run(facts)
 
-  results.map(result => console.log(result.event.params.message.red))
+  events.map(event => console.log(event.params.message.red))
 }
 start()
 /*

examples/03-dynamic-facts.js

@@ -70,9 +70,9 @@ async function start () {
 
   // define fact(s) known at runtime
   const facts = { accountId: 'lincoln' }
-  const { results } = await engine.run(facts)
+  const { events } = await engine.run(facts)
 
-  console.log(facts.accountId + ' is a ' + results.map(result => result.event.params.message))
+  console.log(facts.accountId + ' is a ' + events.map(event => event.params.message))
 }
 start()