Skip to content

Commit

Permalink
chore: update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mastro993 committed Mar 5, 2025
1 parent 5ac62d0 commit 02f3877
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions ts/features/connectivity/hooks/useConnectivityGuard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ type ConnectivityCheckFunction<T> = (...args: Array<T>) => void | Promise<void>;

/**
* A hook that executes a function if there is connectivity, otherwise navigates to NoConnectivityScreen.
* Use this hook to wrap functions that require an internet connection to work.
* Use this hook to wrap functions that trigger a navigation to screens that require an internet connection to work.
*
* @example
* ```typescript
* const yourFunctionWithConnectivity = useConnectivityGuard(yourFunction);
* const yourWrappedFunction = useConnectivityGuard(yourFunction);
* ```
*
* @param fn The function to execute when there is connectivity
Expand Down

0 comments on commit 02f3877

Please sign in to comment.