docs(nx): show how to configure an effect not to dispatch an action

nrwl · Nov 17, 2017 · 846d5e4 · 846d5e4
1 parent 194e9b3
commit 846d5e4
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/packages/nx/src/data-persistence.ts b/packages/nx/src/data-persistence.ts
@@ -81,6 +81,16 @@ export class DataPersistence<T> {
    *   constructor(private s: DataPersistence<TodosState>, private backend: Backend) {}
    * }
    * ```
+   *
+   * Note that if you don't return a new action from the run callback, you must set the dispatch property
+   * of the effect to false, like this:
+   *
+   * ```
+   * class TodoEffects {
+   *   @Effect({dispatch: false})
+   *   updateTodo; //...
+   * }
+   * ```
    */
   pessimisticUpdate<A extends Action = Action>(actionType: string, opts: PessimisticUpdateOpts<T, A>): Observable<any> {
     const nav = this.actions.ofType<A>(actionType);
@@ -123,6 +133,16 @@ export class DataPersistence<T> {
    *   constructor(private s: DataPersistence<TodosState>, private backend: Backend) {}
    * }
    * ```
+   *
+   * Note that if you don't return a new action from the run callback, you must set the dispatch property
+   * of the effect to false, like this:
+   *
+   * ```
+   * class TodoEffects {
+   *   @Effect({dispatch: false})
+   *   updateTodo; //...
+   * }
+   * ```
    */
   optimisticUpdate<A extends Action = Action>(actionType: string, opts: OptimisticUpdateOpts<T, A>): Observable<any> {
     const nav = this.actions.ofType<A>(actionType);
@@ -243,7 +263,6 @@ export class DataPersistence<T> {
    *   constructor(private s: DataPersistence<TodosState>, private backend: Backend) {}
    * }
    * ```
-   *
    */
   navigation(component: Type<any>, opts: HandleNavigationOpts<T>): Observable<any> {
     const nav = this.actions