Rename state-change event to stateChange

This event name matches the naming convention of the event prefix, which is also camelCase.
MetaMask · Mar 8, 2021 · 5202621 · 5202621
1 parent e160c19
commit 5202621
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 17 deletions.
diff --git a/src/BaseControllerV2.test.ts b/src/BaseControllerV2.test.ts
@@ -9,7 +9,7 @@ type CountControllerState = {
 };
 
 type CountControllerEvent = {
-  type: `CountController:state-change`;
+  type: `CountController:stateChange`;
   payload: [CountControllerState, Patch[]];
 };
 
@@ -129,8 +129,8 @@ describe('BaseController', () => {
     const listener1 = sinon.stub();
     const listener2 = sinon.stub();
 
-    controllerMessenger.subscribe('CountController:state-change', listener1);
-    controllerMessenger.subscribe('CountController:state-change', listener2);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener2);
     controller.update(() => {
       return { count: 1 };
     });
@@ -151,8 +151,8 @@ describe('BaseController', () => {
     );
     const listener1 = sinon.stub();
 
-    controllerMessenger.subscribe('CountController:state-change', listener1);
-    controllerMessenger.subscribe('CountController:state-change', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
 
     controller.update(() => {
       return { count: 1 };
@@ -172,8 +172,8 @@ describe('BaseController', () => {
     );
     const listener1 = sinon.stub();
 
-    controllerMessenger.subscribe('CountController:state-change', listener1);
-    controllerMessenger.unsubscribe('CountController:state-change', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
+    controllerMessenger.unsubscribe('CountController:stateChange', listener1);
     controller.update(() => {
       return { count: 1 };
     });
@@ -191,9 +191,9 @@ describe('BaseController', () => {
     );
     const listener1 = sinon.stub();
 
-    controllerMessenger.subscribe('CountController:state-change', listener1);
-    controllerMessenger.subscribe('CountController:state-change', listener1);
-    controllerMessenger.unsubscribe('CountController:state-change', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
+    controllerMessenger.unsubscribe('CountController:stateChange', listener1);
     controller.update(() => {
       return { count: 1 };
     });
@@ -207,7 +207,7 @@ describe('BaseController', () => {
     const listener1 = sinon.stub();
 
     expect(() => {
-      controllerMessenger.unsubscribe('CountController:state-change', listener1);
+      controllerMessenger.unsubscribe('CountController:stateChange', listener1);
     }).toThrow();
   });
 
@@ -222,8 +222,8 @@ describe('BaseController', () => {
     const listener1 = sinon.stub();
     const listener2 = sinon.stub();
 
-    controllerMessenger.subscribe('CountController:state-change', listener1);
-    controllerMessenger.subscribe('CountController:state-change', listener2);
+    controllerMessenger.subscribe('CountController:stateChange', listener1);
+    controllerMessenger.subscribe('CountController:stateChange', listener2);
     controller.destroy();
     controller.update(() => {
       return { count: 1 };

diff --git a/src/BaseControllerV2.ts b/src/BaseControllerV2.ts
@@ -101,7 +101,7 @@ type Json = null | boolean | number | string | Json[] | { [prop: string]: Json }
 export class BaseController<N extends string, S extends Record<string, unknown>> {
   private internalState: IsJsonable<S>;
 
-  private messagingSystem: ControllerMessenger<never, { type: `${N}:state-change`; payload: [S, Patch[]] }>;
+  private messagingSystem: ControllerMessenger<never, { type: `${N}:stateChange`; payload: [S, Patch[]] }>;
 
   private name: N;
 
@@ -116,7 +116,7 @@ export class BaseController<N extends string, S extends Record<string, unknown>>
    *   and which parts should be persisted.
    */
   constructor(
-    messagingSystem: ControllerMessenger<never, { type: `${N}:state-change`; payload: [S, Patch[]] }>,
+    messagingSystem: ControllerMessenger<never, { type: `${N}:stateChange`; payload: [S, Patch[]] }>,
     name: N,
     state: IsJsonable<S>,
     metadata: StateMetadata<S>,
@@ -152,7 +152,7 @@ export class BaseController<N extends string, S extends Record<string, unknown>>
   protected update(callback: (state: Draft<IsJsonable<S>>) => void | IsJsonable<S>) {
     const [nextState, patches] = produceWithPatches(this.internalState, callback);
     this.internalState = nextState as IsJsonable<S>;
-    this.messagingSystem.publish(`${this.name}:state-change` as `${N}:state-change`, nextState as S, patches);
+    this.messagingSystem.publish(`${this.name}:stateChange` as `${N}:stateChange`, nextState as S, patches);
   }
 
   /**
@@ -165,7 +165,7 @@ export class BaseController<N extends string, S extends Record<string, unknown>>
    * listeners from being garbage collected.
    */
   protected destroy() {
-    this.messagingSystem.clearEventSubscriptions(`${this.name}:state-change` as `${N}:state-change`);
+    this.messagingSystem.clearEventSubscriptions(`${this.name}:stateChange` as `${N}:stateChange`);
   }
 }