doc: add query preview events types documentation

EMP-3079
empathyco · Jan 15, 2024 · 1d86255 · 1d86255
1 parent 218bf6e
commit 1d86255
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/packages/x-components/src/x-modules/queries-preview/events.types.ts b/packages/x-components/src/x-modules/queries-preview/events.types.ts
@@ -36,6 +36,18 @@ export interface QueriesPreviewXEvents {
    * query preview selection.
    */
   QueryPreviewUnselected: Dictionary<unknown>;
+  /**
+   * The query preview has been mounted.
+   * Payload: The query preview query as a key converted into a unique id (query hash).
+   * When QueryPreviewMounted is emitted, the instances count is increased.
+   */
   QueryPreviewMounted: string;
+  /**
+   * The query preview has been unmounted.
+   * Payload: The query preview's unique id (query hash) and its cache value.
+   * When QueryPreviewUnmounted is emitted, the instance count for that query hash
+   * will be decreased. If the cache is set to false, the query will be removed
+   * safely from the state since there will be no component showing that data.
+   */
   QueryPreviewUnmounted: { query: string; cache: boolean };
 }