feat(types): adding logger type for logger plugin (#1853)

itomtom · Thomas Truong · web-flow · commit cb3198d5998b · 2020-10-23T18:47:28.000+09:00
`createLogger` takes in logger option which by default is console but
can be overridden with own logger. Here we addd `Logger` interface
for `logger` options params which expects log method to
be implemented.

Co-authored-by: Thomas Truong &lt;ttruong@factset.com&gt;
diff --git a/types/logger.d.ts b/types/logger.d.ts
@@ -1,5 +1,10 @@
 import { Payload, Plugin } from "./index";
 
+interface Logger extends Partial<Pick<Console, 'groupCollapsed' | 'group' | 'groupEnd'>> {
+  log(message: string, colour: string, action: any): void;
+  log(message: string): void;
+}
+
 export interface LoggerOption<S> {
   collapsed?: boolean;
   filter?: <P extends Payload>(mutation: P, stateBefore: S, stateAfter: S) => boolean;
@@ -9,6 +14,7 @@ export interface LoggerOption<S> {
   actionTransformer?: <P extends Payload>(action: P) => any;
   logMutations?: boolean;
   logActions?: boolean;
+  logger?: Logger;
 }
 
 export default function createLogger<S>(option?: LoggerOption<S>): Plugin<S>;
diff --git a/types/test/index.ts b/types/test/index.ts
@@ -437,10 +437,17 @@ namespace Plugins {
     });
   }
 
+  class MyLogger {
+    log(message: string) {
+       console.log(message);
+    }
+  }
+
   const logger = Vuex.createLogger<{ value: number }>({
     collapsed: true,
     transformer: state => state.value,
-    mutationTransformer: (mutation: { type: string }) => mutation.type
+    mutationTransformer: (mutation: { type: string }) => mutation.type,
+    logger: new MyLogger()
   });
 
   const store = new Vuex.Store<{ value: number }>({
