diff --git a/.changeset/slow-breads-pump.md b/.changeset/slow-breads-pump.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/slow-breads-pump.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/packages/react/src/hooks/useAuth.ts b/packages/react/src/hooks/useAuth.ts index 1e3619099fb..c8896134628 100644 --- a/packages/react/src/hooks/useAuth.ts +++ b/packages/react/src/hooks/useAuth.ts @@ -33,7 +33,7 @@ type UseAuthOptions = PendingSessionOptions | undefined | null; * * * @unionReturnHeadings - * ["Initialization", "Signed out", "Signed in (no active organization)", "Signed in (with active organization)"] + * ["Loading", "Signed out", "Signed in (no active organization)", "Signed in (with active organization)"] * * @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`. * diff --git a/packages/shared/src/react/hooks/useSession.ts b/packages/shared/src/react/hooks/useSession.ts index ce795c7117e..2838ae60430 100644 --- a/packages/shared/src/react/hooks/useSession.ts +++ b/packages/shared/src/react/hooks/useSession.ts @@ -10,7 +10,7 @@ const hookName = `useSession`; * 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. * * @unionReturnHeadings - * ["Initialization", "Signed out", "Signed in"] + * ["Loading", "Signed out", "Signed in"] * * @function * diff --git a/packages/shared/src/react/hooks/useUser.ts b/packages/shared/src/react/hooks/useUser.ts index 4f6388f4986..e092c576b6e 100644 --- a/packages/shared/src/react/hooks/useUser.ts +++ b/packages/shared/src/react/hooks/useUser.ts @@ -5,10 +5,10 @@ import { useUserBase } from './base/useUserBase'; const hookName = 'useUser'; /** - * 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. + * 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. * * @unionReturnHeadings - * ["Initialization", "Signed out", "Signed in"] + * ["Loading", "Signed out", "Signed in"] * * @example * ### Get the current user