Add comments

elastic · Feb 20, 2020 · 66c4590 · 66c4590
1 parent 60db616
commit 66c4590
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/store/index.ts b/x-pack/plugins/endpoint/public/applications/endpoint/store/index.ts
@@ -48,10 +48,16 @@ export const substateMiddlewareFactory = <Substate>(
   };
 };
 
-export const appStoreFactory: (coreStart: CoreStart, disableMiddleware?: boolean) => Store = (
-  coreStart,
-  disableMiddleware = false
-) => {
+export const appStoreFactory: (
+  /**
+   * Allow middleware to communicate with Kibana core.
+   */
+  coreStart: CoreStart,
+  /**
+   * Create the store without any middleware. This is useful for testing the store w/o side effects.
+   */
+  disableMiddleware?: boolean
+) => Store = (coreStart, disableMiddleware = false) => {
   const store = createStore(
     appReducer,
     disableMiddleware