improve

src/plugins/kibana_utils/public/index.ts

@@ -47,7 +47,6 @@ export {
   syncStates,
   createKbnUrlSyncStrategy,
   createSessionStorageSyncStrategy,
-  ISyncStrategy,
   IStateSyncConfig,
   ISyncStateRef,
   IKbnUrlSyncStrategy,

src/plugins/kibana_utils/public/state_sync/index.ts

@@ -20,7 +20,6 @@
 export {
   createKbnUrlSyncStrategy,
   createSessionStorageSyncStrategy,
-  ISyncStrategy,
   IKbnUrlSyncStrategy,
   ISessionStorageSyncStrategy,
 } from './state_sync_strategies';

src/plugins/kibana_utils/public/state_sync/state_sync_strategies/create_kbn_url_sync_strategy.ts

@@ -54,6 +54,7 @@ export const createKbnUrlSyncStrategy = (
       state: State,
       { replace = false }: { replace: boolean } = { replace: false }
     ) => {
+      // syncState() utils doesn't wait for this promise
       return url.updateAsync(
         currentUrl => setStateToKbnUrl(syncKey, state, { useHash }, currentUrl),
         replace

src/plugins/kibana_utils/public/state_sync/types.ts

@@ -21,10 +21,10 @@ import { BaseStateContainer } from '../state_containers/types';
 import { ISyncStrategy } from './state_sync_strategies';
 
 export interface INullableBaseStateContainer<State> extends BaseStateContainer<State> {
-  // State sync state container have to handle setting "null"
-  // set() implementation could handle null and fallback to some state defaults
-  // this is required to handle edge case, when state in storage became empty and syncing is in progress.
-  // state container will be notified about about storage becoming empty
+  // State container for stateSync() have to accept "null"
+  // for example, set() implementation could handle null and fallback to some default state
+  // this is required to handle edge case, when state in storage becomes empty and syncing is in progress.
+  // state container will be notified about about storage becoming empty with null passed in
   set: (state: State | null) => void;
 }