👌 add PreventExitListenerResult to export

monkvision · Jul 17, 2024 · b9537e8 · b9537e8
1 parent e29a689
commit b9537e8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/common/src/PreventExit/hooks.ts b/packages/common/src/PreventExit/hooks.ts
@@ -1,5 +1,5 @@
 import { useEffect, useMemo } from 'react';
-import { createPreventExitListener } from './store';
+import { PreventExitListenerResult, createPreventExitListener } from './store';
 
 /**
  * Custom hook that allows preventing the user from exiting the page or navigating away.
@@ -16,7 +16,7 @@ import { createPreventExitListener } from './store';
  */
 export function usePreventExit(
   preventExit: boolean,
-): Pick<ReturnType<typeof createPreventExitListener>, 'allowRedirect'> {
+): Pick<PreventExitListenerResult, 'allowRedirect'> {
   const { cleanup, setPreventExit, allowRedirect } = useMemo(createPreventExitListener, []);
   useEffect(() => setPreventExit(preventExit), [preventExit]);
   useEffect(() => cleanup, []);

diff --git a/packages/common/src/PreventExit/store.ts b/packages/common/src/PreventExit/store.ts
@@ -19,7 +19,10 @@ function publish(id: symbol, preventExit: boolean) {
     };
 }
 
-interface PreventExitListenerResult {
+/**
+ * Returns a listener which can used to calculate the state of prevent exit
+ */
+export interface PreventExitListenerResult {
   /**
    * Callback used to set the value indicating if direct exit of the page is currently allowed or not.
    */