Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alexis Aguilar <[email protected]>
  • Loading branch information
victoriaxyz and alexisintech authored Dec 17, 2024
1 parent 4459796 commit b3e008f
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/references/react/use-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: '`useAuth()`'
description: Access and manage authentication state in your React application with Clerk's useAuth() hook.
---

The `useAuth()` hook provides access to the current authentication state and methods to manage the active session in your React application.
The `useAuth()` hook provides access to the current user's authentication state and methods to manage the active session.

## Returns

Expand Down Expand Up @@ -60,7 +60,7 @@ The `useAuth()` hook provides access to the current authentication state and met
- `signOut()`
- `(options?: SignOutOptions) => Promise<void>`

## A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](/docs/references/javascript/clerk/clerk#sign-out).
A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](/docs/references/javascript/clerk/clerk#sign-out).

- `getToken()`
- `(options?: GetTokenOptions) => Promise<string | null>`
Expand Down
8 changes: 4 additions & 4 deletions docs/references/react/use-organization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,28 @@ The `useOrganization()` hook retrieves attributes of the currently active organi

<Properties>
- `invitations`
- `true | { status?: OrganizationInvitationStatus } & SharedProperties`
- `true | { status?: OrganizationInvitationStatus } & { SharedProperties }`

If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `status` property of type [`OrganizationInvitationStatus`](#organization-invitation-status) and any of the properties described in [Shared properties](#shared-properties).

---

- `membershipRequests`
- `true | { status?: OrganizationInvitationStatus } & SharedProperties`
- `true | { status?: OrganizationInvitationStatus } & { SharedProperties }`

If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `status` property of type [`OrganizationInvitationStatus`](#organization-invitation-status) and any of the properties described in [Shared properties](#shared-properties).

---

- `memberships`
- `true | { role?: OrganizationCustomRoleKey[] } & SharedProperties`
- `true | { role?: OrganizationCustomRoleKey[] } & { SharedProperties }`

If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `role` property of type [`OrganizationCustomRoleKey[]`](#organization-custome-role-key) and any of the properties described in [Shared properties](#shared-properties).

---

- `domains`
- `true | { enrollmentMode?: OrganizationEnrollmentMode } & SharedProperties`
- `true | { enrollmentMode?: OrganizationEnrollmentMode } & { SharedProperties }`

If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `enrollmentMode` property of type [`OrganizationEnrollmentMode`](#organization-enrollment-mode) and any of the properties described in [Shared properties](#shared-properties).
</Properties>
Expand Down
4 changes: 2 additions & 2 deletions docs/references/react/use-sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Access and manage the current user's sign-in state in your React ap

The `useSignIn()` composable provides access to the [`SignIn`](/docs/references/javascript/sign-in/sign-in) object, which allows you to check the current state of a sign-in attempt and manage the sign-in flow. You can use this to create a [custom sign-in flow](/docs/custom-flows/overview#sign-in-flow).

## Reacteturns
## Returns

<Properties>
- `isLoaded`
Expand Down Expand Up @@ -101,7 +101,7 @@ The `status` property of the `SignIn` object can be one of the following values:
- `needs_identifier`
- `string`

The user's identifier (e.g., email address, phone number, username) hasn't been provided.
The user's [identifier](/docs/authentication/configuration/sign-up-sign-in-options#identifiers) (e.g., email address, phone number, username) is missing.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/references/react/use-sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: '`useSignUp()`'
description: Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
---

The `useSignUp()` composable provides access to the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object, which allows you to check the current state of a sign-up attempt and manage the sign-up flow. You can use this to create a [custom sign-up flow](/docs/custom-flows/overview#sign-up-flow).
The `useSignUp()` hook provides access to the [`SignUp`](/docs/references/javascript/sign-up/sign-up) object, which allows you to check the current state of a sign-up attempt and manage the sign-up flow. You can use this to create a [custom sign-up flow](/docs/custom-flows/overview#sign-up-flow).

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/references/react/use-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `useUser()` hook provides access to the current user's [`User`](/docs/refere
---

- `user`
- [`User`](/docs/references/javascript/user/user)
- <code>[User](/docs/references/javascript/user/user) \| null</code>

The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
</Properties>
Expand Down

0 comments on commit b3e008f

Please sign in to comment.