refactor: 💡 make Versioned state be an object

elastic · Jun 30, 2021 · 32a61bf · 32a61bf
1 parent cc1ef6d
commit 32a61bf
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/src/plugins/kibana_utils/common/persistable_state/migrate_to_latest.ts b/src/plugins/kibana_utils/common/persistable_state/migrate_to_latest.ts
@@ -11,17 +11,20 @@ import { SerializableState, VersionedState, MigrateFunctionsObject } from './typ
 
 export function migrateToLatest<S extends SerializableState>(
   migrations: MigrateFunctionsObject,
-  [state, oldVersion]: VersionedState
+  { state, version: oldVersion }: VersionedState
 ): VersionedState<S> {
   const versions = Object.keys(migrations || {})
     .filter((v) => compare(v, oldVersion) > 0)
     .sort(compare);
 
-  if (!versions.length) return [state, oldVersion] as VersionedState<S>;
+  if (!versions.length) return { state, version: oldVersion } as VersionedState<S>;
 
   for (const version of versions) {
     state = migrations[version]!(state);
   }
 
-  return [state as S, versions[versions.length - 1]];
+  return {
+    state: state as S,
+    version: versions[versions.length - 1],
+  };
 }
diff --git a/src/plugins/kibana_utils/common/persistable_state/types.ts b/src/plugins/kibana_utils/common/persistable_state/types.ts
@@ -27,13 +27,18 @@ export type Serializable = SerializableValue | SerializableValue[];
  * For example:
  *
  * ```ts
- * const obj: VersionedState<{ dashboardId: string }> = [{ dashboardId: '123' }, '7.14.0'];
+ * const obj: VersionedState<{ dashboardId: string }> = {
+ *   version: '7.14.0',
+ *   state: {
+ *     dashboardId: '123',
+ *   },
+ * };
  * ```
  */
-export type VersionedState<S extends SerializableState = SerializableState> = [
-  state: S,
-  version: string
-];
+export interface VersionedState<S extends SerializableState = SerializableState> {
+  version: string;
+  state: S;
+}
 
 /**
  * Persistable state interface can be implemented by something that persists