Skip to content

Commit 4b44732

Browse files
SarahSoutoulmanovotnyclaude
authored
docs(repo): Add new tab name for hooks (#8435)
Co-authored-by: Michael Novotny <manovotny@gmail.com> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 1084180 commit 4b44732

4 files changed

Lines changed: 6 additions & 4 deletions

File tree

.changeset/slow-breads-pump.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

packages/react/src/hooks/useAuth.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ type UseAuthOptions = PendingSessionOptions | undefined | null;
3333
* </If>
3434
*
3535
* @unionReturnHeadings
36-
* ["Initialization", "Signed out", "Signed in (no active organization)", "Signed in (with active organization)"]
36+
* ["Loading", "Signed out", "Signed in (no active organization)", "Signed in (with active organization)"]
3737
*
3838
* @param [options] - An object containing options for the `useAuth()` hook. `treatPendingAsSignedOut` is a boolean that indicates whether pending sessions are considered as signed out or not. Defaults to `true`.
3939
*

packages/shared/src/react/hooks/useSession.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const hookName = `useSession`;
1010
* The `useSession()` hook provides access to the current user's [`Session`](https://clerk.com/docs/reference/objects/session) object, as well as helpers for setting the active session.
1111
*
1212
* @unionReturnHeadings
13-
* ["Initialization", "Signed out", "Signed in"]
13+
* ["Loading", "Signed out", "Signed in"]
1414
*
1515
* @function
1616
*

packages/shared/src/react/hooks/useUser.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ import { useUserBase } from './base/useUserBase';
55

66
const hookName = 'useUser';
77
/**
8-
* The `useUser()` hook provides access to the current user's [`User`](https://clerk.com/docs/reference/objects/user) object, which contains all the data for a single user in your application and provides methods to manage their account. This hook also allows you to check if the user is signed in and if Clerk has loaded and initialized.
8+
* The `useUser()` hook provides access to the current user's [`User`](https://clerk.com/docs/reference/objects/user) object, which contains all the data for a single user in your application and provides methods to manage their account. This hook also allows you to check if the user is signed in and if Clerk has loaded.
99
*
1010
* @unionReturnHeadings
11-
* ["Initialization", "Signed out", "Signed in"]
11+
* ["Loading", "Signed out", "Signed in"]
1212
*
1313
* @example
1414
* ### Get the current user

0 commit comments

Comments
 (0)