From b0a6c9acc1dc0ccd1f0da78df03bb9f6642484cb Mon Sep 17 00:00:00 2001 From: vi Date: Tue, 17 Dec 2024 21:17:39 -0500 Subject: [PATCH] align text --- docs/references/astro/auth-store.mdx | 10 +++++----- .../backend/email-addresses/create-email-address.mdx | 2 +- .../organization/create-organization-membership.mdx | 2 +- .../organization/delete-organization-membership.mdx | 2 +- .../update-organization-membership-metadata.mdx | 2 +- .../organization/update-organization-membership.mdx | 2 +- .../backend/phone-numbers/create-phone-number.mdx | 2 +- docs/references/backend/sessions/get-session.mdx | 2 +- docs/references/backend/sessions/get-token.mdx | 2 +- docs/references/backend/sessions/revoke-session.mdx | 2 +- docs/references/backend/sessions/verify-session.mdx | 2 +- .../backend/sign-in-tokens/create-sign-in-token.mdx | 2 +- .../backend/types/backend-organization-membership.mdx | 2 +- docs/references/backend/types/backend-session.mdx | 2 +- docs/references/backend/user/ban-user.mdx | 2 +- docs/references/backend/user/delete-user.mdx | 2 +- docs/references/backend/user/disable-user-mfa.mdx | 2 +- .../backend/user/get-organization-membership-list.mdx | 2 +- .../backend/user/get-user-oauth-access-token.mdx | 2 +- docs/references/backend/user/get-user.mdx | 2 +- docs/references/backend/user/lock-user.mdx | 2 +- docs/references/backend/user/unban-user.mdx | 2 +- docs/references/backend/user/unlock-user.mdx | 2 +- docs/references/backend/user/update-user-metadata.mdx | 2 +- docs/references/backend/user/update-user.mdx | 2 +- docs/references/backend/user/verify-password.mdx | 2 +- docs/references/backend/user/verify-totp.mdx | 2 +- docs/references/javascript/organization/members.mdx | 6 +++--- docs/references/nextjs/auth-object.mdx | 10 +++++----- docs/references/react/use-auth.mdx | 4 ++-- docs/references/react/use-user.mdx | 2 +- 31 files changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/references/astro/auth-store.mdx b/docs/references/astro/auth-store.mdx index d35f7d3b8e..472f8cd029 100644 --- a/docs/references/astro/auth-store.mdx +++ b/docs/references/astro/auth-store.mdx @@ -11,35 +11,35 @@ The `$authStore` store provides a convenient way to access the current auth stat - `userId` - `string` - The current user's ID. + The unique identifier of the current user. --- - `sessionId` - `string` - The current user's session ID. + The unique identifier of the current session. --- - `orgId` - `string` - The current user's active organization ID. + The unique identifier of the user's active organization. --- - `orgRole` - `string` - The current user's active organization role. + The current user's role in their active organization. --- - `orgSlug` - `string` - The current user's active organization slug. + The URL-friendly identifier of the user's active organization. ## How to use the `$authStore` store diff --git a/docs/references/backend/email-addresses/create-email-address.mdx b/docs/references/backend/email-addresses/create-email-address.mdx index e4a1e9c6f1..099079ff9d 100644 --- a/docs/references/backend/email-addresses/create-email-address.mdx +++ b/docs/references/backend/email-addresses/create-email-address.mdx @@ -17,7 +17,7 @@ function createEmailAddress(params: CreateEmailAddressParams): Promise ## Example diff --git a/docs/references/backend/organization/update-organization-membership-metadata.mdx b/docs/references/backend/organization/update-organization-membership-metadata.mdx index d46f78f7af..4b7b156d3c 100644 --- a/docs/references/backend/organization/update-organization-membership-metadata.mdx +++ b/docs/references/backend/organization/update-organization-membership-metadata.mdx @@ -26,7 +26,7 @@ function updateOrganizationMembershipMetadata( - `userId` - `string` - The ID of the user that this membership belongs to. + The unique identifier of the user that this membership belongs to. --- diff --git a/docs/references/backend/organization/update-organization-membership.mdx b/docs/references/backend/organization/update-organization-membership.mdx index 977f311eb7..ac097a8354 100644 --- a/docs/references/backend/organization/update-organization-membership.mdx +++ b/docs/references/backend/organization/update-organization-membership.mdx @@ -26,7 +26,7 @@ function updateOrganizationMembership( - `userId` - `string` - The ID of the user. + The unique identifier of the user to update. --- diff --git a/docs/references/backend/phone-numbers/create-phone-number.mdx b/docs/references/backend/phone-numbers/create-phone-number.mdx index 8dba79c808..8b4a62ca16 100644 --- a/docs/references/backend/phone-numbers/create-phone-number.mdx +++ b/docs/references/backend/phone-numbers/create-phone-number.mdx @@ -17,7 +17,7 @@ function createPhoneNumber(params: CreatePhoneNumberParams): Promise - `sessionId` - `string` - The ID of the session to retrieve. + The unique identifier of the session to retrieve. ## Example diff --git a/docs/references/backend/sessions/get-token.mdx b/docs/references/backend/sessions/get-token.mdx index b3265c7212..c866c83bc9 100644 --- a/docs/references/backend/sessions/get-token.mdx +++ b/docs/references/backend/sessions/get-token.mdx @@ -17,7 +17,7 @@ function getToken(sessionId: string, template: string): Promise - `sessionId` - `string` - The ID of the session to retrieve a token for. + The unique identifier of the session to retrieve a token for. --- diff --git a/docs/references/backend/sessions/revoke-session.mdx b/docs/references/backend/sessions/revoke-session.mdx index 1bd321ff87..5686150247 100644 --- a/docs/references/backend/sessions/revoke-session.mdx +++ b/docs/references/backend/sessions/revoke-session.mdx @@ -19,7 +19,7 @@ function revokeSession(sessionId: string): Promise - `sessionId` - `string` - The ID of the session to revoke. + The unique identifier of the session to revoke. ## Example diff --git a/docs/references/backend/sessions/verify-session.mdx b/docs/references/backend/sessions/verify-session.mdx index 36fd248cfc..c1769fe0db 100644 --- a/docs/references/backend/sessions/verify-session.mdx +++ b/docs/references/backend/sessions/verify-session.mdx @@ -27,7 +27,7 @@ const session = await clerkClient.sessions.verifySession(sessionId, token) - `sessionId` - `string` - The ID of the session to verify. + The unique identifier of the session to verify. --- diff --git a/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx b/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx index 393dc22caf..aef9be93d4 100644 --- a/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx +++ b/docs/references/backend/sign-in-tokens/create-sign-in-token.mdx @@ -15,7 +15,7 @@ function createSignInToken(params: CreateSignInTokensParams): Promise diff --git a/docs/references/backend/types/backend-session.mdx b/docs/references/backend/types/backend-session.mdx index 2e9124eb48..9dfab98655 100644 --- a/docs/references/backend/types/backend-session.mdx +++ b/docs/references/backend/types/backend-session.mdx @@ -25,7 +25,7 @@ The Backend `Session` object is similar to the [`Session`](/docs/references/java - `userId` - `string` - The ID of the user associated with the `Session`. + The unique identifier of the current user associated with the `Session`. --- diff --git a/docs/references/backend/user/ban-user.mdx b/docs/references/backend/user/ban-user.mdx index 8586fc9f91..289cb9384d 100644 --- a/docs/references/backend/user/ban-user.mdx +++ b/docs/references/backend/user/ban-user.mdx @@ -17,7 +17,7 @@ function banUser(userId: string): Promise - `userId` - `string` - The ID of the user to ban. + The unique identifier of the user to ban. ## Example diff --git a/docs/references/backend/user/delete-user.mdx b/docs/references/backend/user/delete-user.mdx index 0d245b925e..5015db42ce 100644 --- a/docs/references/backend/user/delete-user.mdx +++ b/docs/references/backend/user/delete-user.mdx @@ -17,7 +17,7 @@ function deleteUser(userId: string): Promise - `userId` - `string` - The ID of the user to delete. + The unique identifier of the user to delete. ## Example diff --git a/docs/references/backend/user/disable-user-mfa.mdx b/docs/references/backend/user/disable-user-mfa.mdx index dd2540c0a9..6de6b4567f 100644 --- a/docs/references/backend/user/disable-user-mfa.mdx +++ b/docs/references/backend/user/disable-user-mfa.mdx @@ -17,7 +17,7 @@ function disableUserMFA(userId: string): Promise - `userId` - `string` - The ID of the user to disable MFA for. + The unique identifier of the user to disable MFA for. ## Example diff --git a/docs/references/backend/user/get-organization-membership-list.mdx b/docs/references/backend/user/get-organization-membership-list.mdx index 7780a1a142..cc878bf70e 100644 --- a/docs/references/backend/user/get-organization-membership-list.mdx +++ b/docs/references/backend/user/get-organization-membership-list.mdx @@ -19,7 +19,7 @@ function getOrganizationMembershipList( - `userId` - `string` - The ID of the user to retrieve the list of organization memberships for. + The unique identifier of the user to retrieve the list of organization memberships for. --- diff --git a/docs/references/backend/user/get-user-oauth-access-token.mdx b/docs/references/backend/user/get-user-oauth-access-token.mdx index e75f7979a1..bb3897585b 100644 --- a/docs/references/backend/user/get-user-oauth-access-token.mdx +++ b/docs/references/backend/user/get-user-oauth-access-token.mdx @@ -20,7 +20,7 @@ function getUserOauthAccessToken( - `userId` - `string` - The ID of the user to retrieve. + The unique identifier of the user to retrieve. --- diff --git a/docs/references/backend/user/get-user.mdx b/docs/references/backend/user/get-user.mdx index 4122ea8d16..f24da21821 100644 --- a/docs/references/backend/user/get-user.mdx +++ b/docs/references/backend/user/get-user.mdx @@ -17,7 +17,7 @@ function getUser(userId: string): Promise - `userId` - `string` - The ID of the user to retrieve. + The unique identifier of the user to retrieve. ## Example diff --git a/docs/references/backend/user/lock-user.mdx b/docs/references/backend/user/lock-user.mdx index 667d8a5238..e5a089fd91 100644 --- a/docs/references/backend/user/lock-user.mdx +++ b/docs/references/backend/user/lock-user.mdx @@ -19,7 +19,7 @@ function lockUser(userId: string): Promise - `userId` - `string` - The ID of the user to lockout. + The unique identifier of the user to lockout. ## Example diff --git a/docs/references/backend/user/unban-user.mdx b/docs/references/backend/user/unban-user.mdx index 5689fe57ca..09b2c62143 100644 --- a/docs/references/backend/user/unban-user.mdx +++ b/docs/references/backend/user/unban-user.mdx @@ -17,7 +17,7 @@ function unbanUser(userId: string): Promise - `userId` - `string` - The ID of the user to unban. + The unique identifier of the user to unban. ## Example diff --git a/docs/references/backend/user/unlock-user.mdx b/docs/references/backend/user/unlock-user.mdx index 438ed78f78..e07675e158 100644 --- a/docs/references/backend/user/unlock-user.mdx +++ b/docs/references/backend/user/unlock-user.mdx @@ -17,7 +17,7 @@ function unlockUser(userId: string): Promise - `userId` - `string` - The ID of the user to unlock. + The unique identifier of the user to unlock. ## Example diff --git a/docs/references/backend/user/update-user-metadata.mdx b/docs/references/backend/user/update-user-metadata.mdx index 7101085538..2367aa50da 100644 --- a/docs/references/backend/user/update-user-metadata.mdx +++ b/docs/references/backend/user/update-user-metadata.mdx @@ -19,7 +19,7 @@ function updateUserMetadata(userId: string, params: UpdateUserMetadataParams): P - `userId` - `string` - The ID of the organization to update. + The unique identifier of the user to update. --- diff --git a/docs/references/backend/user/update-user.mdx b/docs/references/backend/user/update-user.mdx index b146c6f9cd..fc98ccafb5 100644 --- a/docs/references/backend/user/update-user.mdx +++ b/docs/references/backend/user/update-user.mdx @@ -17,7 +17,7 @@ function updateUser(userId: string, params: UpdateUserParams): Promise - `userId` - `string` - The ID of the user to update. + The unique identifier of the user to update. --- diff --git a/docs/references/backend/user/verify-password.mdx b/docs/references/backend/user/verify-password.mdx index 069f1efb34..99d9276f5c 100644 --- a/docs/references/backend/user/verify-password.mdx +++ b/docs/references/backend/user/verify-password.mdx @@ -17,7 +17,7 @@ function verifyPassword(params: VerifyPasswordParams): Promise<{ verified: true - `userId` - `string` - The ID of the user to verify the password for. + The unique identifier of the user to verify the password for. --- diff --git a/docs/references/backend/user/verify-totp.mdx b/docs/references/backend/user/verify-totp.mdx index 649aca2bc3..c35b08d5f4 100644 --- a/docs/references/backend/user/verify-totp.mdx +++ b/docs/references/backend/user/verify-totp.mdx @@ -17,7 +17,7 @@ function verifyTOTP(params: VerifyTOTPParams): Promise<{ verified: true; code_ty - `userId` - `string` - The ID of the user to verify the TOTP for. + The unique identifier of the user to verify the TOTP for. --- diff --git a/docs/references/javascript/organization/members.mdx b/docs/references/javascript/organization/members.mdx index b5aaf8ef96..ae9b4f94a9 100644 --- a/docs/references/javascript/organization/members.mdx +++ b/docs/references/javascript/organization/members.mdx @@ -69,7 +69,7 @@ function addMember(params: AddMemberParams): Promise - `userId` - `string` - The ID of the user that will be added as a member to the organization. + The unique identifier of the user to be added as a member to the organization. --- @@ -99,7 +99,7 @@ function updateMember(params: UpdateMembershipParams): Promise - `userId` - `string` - The user identifier. + The unique identifier of the user to remove from the organization. ### Returns diff --git a/docs/references/nextjs/auth-object.mdx b/docs/references/nextjs/auth-object.mdx index 7ccbab87e2..438b2ee086 100644 --- a/docs/references/nextjs/auth-object.mdx +++ b/docs/references/nextjs/auth-object.mdx @@ -11,35 +11,35 @@ The `Auth` object contains important information like the current user's session - `sessionId` - `string` - The current user's session ID. + The unique identifier of the current session. --- - `userId` - `string` - The current user's unique identifier. + The unique identifier of the current user. --- - `orgId` - `string | undefined` - The current user's active organization ID. + The unique identifier of the user's active organization. --- - `orgRole` - [OrganizationCustomRoleKey](#organization-custom-role-key) | undefined - The current user's active organization role. + The current user's role in their active organization. --- - `orgSlug` - `string |undefined` - The current user's active organization slug. + The URL-friendly identifier of the user's active organization. --- diff --git a/docs/references/react/use-auth.mdx b/docs/references/react/use-auth.mdx index 30ec01f709..cc11067f98 100644 --- a/docs/references/react/use-auth.mdx +++ b/docs/references/react/use-auth.mdx @@ -25,7 +25,7 @@ The `useAuth()` hook provides access to the current user's authentication state - `userId` - `string` - The unique identifier for the current user. + The unique identifier of the current user. --- @@ -39,7 +39,7 @@ The `useAuth()` hook provides access to the current user's authentication state - `orgId` - `string` - The unique identifier for the user's active organization. + The unique identifier of the user's active organization. --- diff --git a/docs/references/react/use-user.mdx b/docs/references/react/use-user.mdx index c189382d68..6799378338 100644 --- a/docs/references/react/use-user.mdx +++ b/docs/references/react/use-user.mdx @@ -23,7 +23,7 @@ The `useUser()` hook provides access to the current user's [`User`](/docs/refere --- - `user` - - [User](/docs/references/javascript/user/user) \| null + - [User](/docs/references/javascript/user/user) | null The `User` object for the current user. If the user isn't signed in, `user` will be `null`.