docs: include minor API changes for handle call in README

arobson · arobson · commit 96fa1864a121 · 2022-05-06T18:37:32.000-07:00
diff --git a/README.md b/README.md
@@ -122,9 +122,9 @@ __options__
 
 ## `handle( actorId, topic|type, command|event )`
 
-Process a command or event and return a promise that resolves to the originating message, the actor snapshot and resulting events. The promise will reject if any problems occur while processing the message.
+Process a command or event and return a promise that resolves to an array of objects that will contain the originating message, the actor snapshot and resulting events. The promise will reject if any problems occur while processing the message.
 
-Successful resolution should provide a hash with the following structure:
+Successful resolution should provide an array of hashes with the following structure:
 ```javascript
 {
 	message: {}, // initiating command message
@@ -135,7 +135,7 @@ Successful resolution should provide a hash with the following structure:
 }
 ```
 
-Rejection will give an error object with the following structure:
+Rejection will result in one or more hashes with the following structure:
 ```javascript
 {
 	rejected: true,
@@ -146,7 +146,7 @@ Rejection will give an error object with the following structure:
 }
 ```
 
-> Note: the actor property will be a clone of the latest snapshot without the events applied.
+> Note: in the event of an error, the state property will be a clone of the latest snapshot without the events applied.
 
 ## Documentation
 

Original file line number	Diff line number	Diff line change
`@@ -122,9 +122,9 @@ __options__`
`122`	`122`
`123`	`123`	## `handle( actorId, topic\|type, command\|event )`
`124`	`124`
`125`		`-Process a command or event and return a promise that resolves to the originating message, the actor snapshot and resulting events. The promise will reject if any problems occur while processing the message.`
	`125`	`+Process a command or event and return a promise that resolves to an array of objects that will contain the originating message, the actor snapshot and resulting events. The promise will reject if any problems occur while processing the message.`
`126`	`126`
`127`		`-Successful resolution should provide a hash with the following structure:`
	`127`	`+Successful resolution should provide an array of hashes with the following structure:`
`128`	`128`	```javascript
`129`	`129`	`{`
`130`	`130`	`message: {}, // initiating command message`
`@@ -135,7 +135,7 @@ Successful resolution should provide a hash with the following structure:`
`135`	`135`	`}`
`136`	`136`	```
`137`	`137`
`138`		`-Rejection will give an error object with the following structure:`
	`138`	`+Rejection will result in one or more hashes with the following structure:`
`139`	`139`	```javascript
`140`	`140`	`{`
`141`	`141`	`rejected: true,`
`@@ -146,7 +146,7 @@ Rejection will give an error object with the following structure:`
`146`	`146`	`}`
`147`	`147`	```
`148`	`148`
`149`		`-> Note: the actor property will be a clone of the latest snapshot without the events applied.`
	`149`	`+> Note: in the event of an error, the state property will be a clone of the latest snapshot without the events applied.`
`150`	`150`
`151`	`151`	`## Documentation`
`152`	`152`