Rename narrowest supertype for composable controller state to use "Co…

…nstraint" suffix
MetaMask · Apr 17, 2024 · 37137b6 · 37137b6
1 parent e0069d4
commit 37137b6
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/composable-controller/src/ComposableController.ts b/packages/composable-controller/src/ComposableController.ts
@@ -120,8 +120,11 @@ type LegacyControllerStateChangeEvent<
   payload: [ControllerState, Patch[]];
 };
 
+/**
+ * A narrowest supertype for the composable controller state object.
+ */
 // TODO: Replace `any` with `Json` once `BaseControllerV2` migrations are completed for all controllers.
-export type ComposableControllerState = {
+export type ComposableControllerStateConstraint = {
   // `any` is used here to disable the `BaseController` type constraint which expects state properties to extend `Record<string, Json>`.
   // `ComposableController` state needs to accommodate `BaseControllerV1` state objects that may have properties wider than `Json`.
   // eslint-disable-next-line @typescript-eslint/no-explicit-any