Change remove trigger to cancel trigger.

In order to simplify and clearly communicate to the user of the
middleware, remove is changed to cancel, and instead of creating a
trigger and then creating an action for the trigger, it is consolidated
into one step.

This means for the user of the library to cancel a trigger, they will
have to access the action.trigger object to pass in to the cancelTrigger
function.

Author: coderkevin

examples/simple/triggers/primeStateTriggers.js

@@ -12,14 +12,14 @@ function queueMatcher( state ) {
 }
 
 export function addQueueTrigger() {
-	return addTrigger( createTrigger(
+	return addTrigger(
 		queueMatcher,
 		( match ) => {
 			return [
 				checkNextPrimeAction(),
 				addQueueTrigger(),
 			];
 		}
-	) );
+	);
 }
 

src/index.js

@@ -1,6 +1,6 @@
 
 const REDUX_TRIGGER_ADD = 'REDUX_TRIGGER_ADD';
-const REDUX_TRIGGER_REMOVE = 'REDUX_TRIGGER_REMOVE';
+const REDUX_TRIGGER_CANCEL = 'REDUX_TRIGGER_CANCEL';
 
 /**
  * Middleware creator.
@@ -11,15 +11,15 @@ function createTriggerMiddleware() {
 	return ( store ) => ( next ) => ( action ) => {
 		switch ( action.type ) {
 			case REDUX_TRIGGER_ADD:
-				triggers.unshift( action.payload );
+				triggers.unshift( action.trigger );
 
 				console.log("** redux-trigger add! **");
 				console.log( triggers );
 				return true;
-			case REDUX_TRIGGER_REMOVE:
-				triggers.splice( triggers.indexOf( action.payload ), 1 );
+			case REDUX_TRIGGER_CANCEL:
+				triggers.splice( triggers.indexOf( action.trigger ), 1 );
 
-				console.log("** redux-trigger remove! **");
+				console.log("** redux-trigger cancel! **");
 				console.log( triggers );
 				return true;
 			default:
@@ -46,48 +46,32 @@ function checkTriggers( store, triggers ) {
 	}
 }
 
-
 /**
- * Convenience function to create a trigger object.
+ * Creates an action to add a new trigger.
  *
  * @param Function matcher ( state )
  * 	return match object when trigger should fire, or null if no match.
  * @param Function actionCreator ( match )
  *  create action using match object.
- * @return Object The trigger object.
- */
-export function createTrigger( matcher, actionCreator ) {
-	return {
-		matcher,
-		actionCreator
-	};
-}
-
-/**
- * Trigger add action creator.
- *
- * @param Object trigger
- *   The trigger object to be added. Must be in the format:
- *   { matcher, actionCreator }
  * @return Object The trigger action to be dispatched.
  */
-export function addTrigger( trigger ) {
+export function addTrigger( matcher, actionCreator ) {
 	return {
 		type: REDUX_TRIGGER_ADD,
-		payload: trigger
+		trigger: { matcher, actionCreator }
 	};
 }
 
 /**
- * Trigger remove action creator.
+ * Creates an action to cancel a trigger.
  *
- * @param Object trigger The trigger object to be removed.
+ * @param Object trigger The trigger object to cancel.
  * @return Object The trigger action to be dispatched.
  */
-export function removeTrigger( trigger ) {
+export function cancelTrigger( trigger ) {
 	return {
-		type: REDUX_TRIGGER_REMOVE,
-		payload: trigger
+		type: REDUX_TRIGGER_CANCEL,
+		trigger
 	};
 }