Patched /Users/codelion/Documents/GitHub/stack/docs/fern/docs/pages/sdk/use-user.mdx

Author: patched.codes[bot]

docs/fern/docs/pages/sdk/use-user.mdx

@@ -1,40 +1,41 @@
 ---
-slug: sdk/use-user
+title: useUser
 ---
 
-`useUser` is a hook that returns the user object if the user is authenticated; otherwise, it returns `null` by default. However, if you pass in `{ or: "redirect" }` or `{ or: "throw" }` as an option, it will redirect to the login page or throw an error respectively when the user is not authenticated.
+# useUser
 
-If you want to learn more about the `User` object, check out the [User](./current-user.mdx) documentation.
+A React hook that retrieves the current user information. It can return different user types based on the provided options.
 
-## Default Usage
+## Parameters
 
-Check if the user is authenticated and display the user's name.
-```jsx
-import { useUser } from "@stackframe/stack";
+- `options` (optional): `GetUserOptions` - Options for retrieving the user.
+  - `or` (optional): `'redirect' | 'throw'` - Specifies behavior if user is not found.
+  - `projectIdMustMatch` (optional): `'internal'` - Ensures the project ID matches 'internal'.
 
-function MyComponent() {
-  const user = useUser(); // user can be null
-  if (!user) {
-    return <div>Not authenticated</div>;
-  }
-  return <div>Hello, {user.name}</div>;
-}
-```
+## Returns
 
-## Redirect when not authenticated
-By passing `{ or: "redirect" }` to the hook, it will redirect to the login page if the user is not authenticated. You can configure the login page in the StackApp component.
-```jsx
-import { useUser } from "@stackframe/stack";
+- `CurrentUser | CurrentInternalUser | null` depending on the options provided.
 
-function MyComponent() {
-  const user = useUser({ or: "redirect" }); // user is garanteed to be non-null
-  return <div>Hello, {user.name}</div>;
-}
-```
+## Examples
 
-The same hook can also be used to protect a page. (You might also want to check out the server-side version [here](../getting-started/users.mdx))
-```jsx
-import { useUser } from "@stackframe/stack";
+```tsx
+import { useUser } from '@stackframe/stack';
+
+// Basic usage
+const user = useUser();
+
+// With options
+const internalUser = useUser({ projectIdMustMatch: 'internal' });
+
+// With redirect or throw option
+const authenticatedUser = useUser({ or: 'redirect' });
+
+// Combining options
+const authenticatedInternalUser = useUser({
+  or: 'throw',
+  projectIdMustMatch: 'internal'
+});
+```import { useUser } from "@stackframe/stack";
 
 function MyProtectedPage() {
   useUser({ or: "redirect" });