Add comment to export member

microsoft · Jun 21, 2024 · c1ceed2 · c1ceed2
1 parent 97e82d8
commit c1ceed2
Showing 1 changed file with 9 additions and 4 deletions.
diff --git a/packages/roosterjs-content-model-core/lib/coreApi/setContentModel/persistHighlight.ts b/packages/roosterjs-content-model-core/lib/coreApi/setContentModel/persistHighlight.ts
@@ -10,10 +10,6 @@ interface WindowWithHighlight extends Window {
     Highlight: typeof Highlight;
 }
 
-export function isWindowWithHighlight(win: Window): win is WindowWithHighlight {
-    return !!(win as WindowWithHighlight).Highlight;
-}
-
 interface HighlightRegistryWithMap extends HighlightRegistry {
     set(name: string, highlight: Highlight): void;
     delete(name: string): void;
@@ -33,6 +29,15 @@ interface CSSShim {
 
 declare const CSS: CSSShim;
 
+/**
+ * @internal
+ * @param win current window that Highlight is being used.
+ * @returns boolean indicates if Highlight api is available
+ */
+export function isWindowWithHighlight(win: Window): win is WindowWithHighlight {
+    return !!(win as WindowWithHighlight).Highlight;
+}
+
 /**
  * @internal
  * Persist highlight of a indicated selection object