Convert BaseConfig, BaseState` interfaces to types

MetaMask · Feb 22, 2024 · 93a997b · 93a997b
1 parent 3302ffc
commit 93a997b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/packages/base-controller/CHANGELOG.md b/packages/base-controller/CHANGELOG.md
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** Convert `BaseConfig`, `BaseState` interfaces to types.
+  - As types, `BaseConfig`, `BaseState` now extend `Record` and have an index signature of `string`.
+
 ## [4.1.1]
 
 ### Changed

diff --git a/packages/base-controller/src/BaseControllerV1.ts b/packages/base-controller/src/BaseControllerV1.ts
@@ -9,25 +9,19 @@ export type Listener<T> = (state: T) => void;
  * Base controller configuration
  * @property disabled - Determines if this controller is enabled
  */
-// This interface was created before this ESLint rule was added.
-// Convert to a `type` in a future major version.
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export interface BaseConfig {
+export type BaseConfig = {
   disabled?: boolean;
-}
+};
 
 /**
  * @type BaseState
  *
  * Base state representation
  * @property name - Unique name for this controller
  */
-// This interface was created before this ESLint rule was added.
-// Convert to a `type` in a future major version.
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export interface BaseState {
+export type BaseState = {
   name?: string;
-}
+};
 
 /**
  * @deprecated This class has been renamed to BaseControllerV1 and is no longer recommended for use for controllers. Please use BaseController (formerly BaseControllerV2) instead.