diff --git a/docs/references/vue/use-auth.mdx b/docs/references/vue/use-auth.mdx index 7731b882e0..e76bc31795 100644 --- a/docs/references/vue/use-auth.mdx +++ b/docs/references/vue/use-auth.mdx @@ -9,70 +9,70 @@ The `useAuth()` composable provides information about the current auth state, as - `isSignedIn` - - `boolean` + - `Ref` A boolean that returns true if the user is signed in. --- - `isLoaded` - - `boolean` + - `Ref` A boolean that until Clerk loads and initializes, will be set to `false`. Once Clerk loads, `isLoaded` will be set to `true`. --- - `userId` - - `string` + - `Ref` The current user's ID. --- - `sessionId` - - `string` + - `Ref` The current user's session ID. --- - `orgId` - - `string` + - `Ref` The current user's active organization ID. --- - `orgRole` - - `string` + - `Ref` The current user's active organization role. --- - `orgSlug` - - `string` + - `Ref` The current user's organization slug. --- - `signOut()` - - `(options?: SignOutOptions) => Promise` + - `Ref<(options?: SignOutOptions) => Promise>` A function that signs the user out. See the [reference documentation](/docs/references/javascript/clerk/clerk#sign-out) for more information. --- - `getToken()` - - `(options?: GetTokenOptions) => Promise` + - `Ref<(options?: GetTokenOptions) => Promise>` A function that returns a promise that resolves to the current user's session token. Can also be used to retrieve a custom JWT template. See the [reference documentation](/docs/references/javascript/session#get-token) for more information. --- - `has()` - - `(isAuthorizedParams: CheckAuthorizationParamsWithCustomPermissions) => boolean` + - `Ref<(isAuthorizedParams: CheckAuthorizationParamsWithCustomPermissions) => boolean>` A function that returns a boolean based on the permission or role provided as parameter. Can be used for authorization. See the [reference documentation](/docs/references/nextjs/auth-object#has){{ target: '_blank' }} for more information. diff --git a/docs/references/vue/use-sign-in.mdx b/docs/references/vue/use-sign-in.mdx index 6ce1ced349..6655600bde 100644 --- a/docs/references/vue/use-sign-in.mdx +++ b/docs/references/vue/use-sign-in.mdx @@ -9,21 +9,21 @@ The `useSignIn()` composable provides access to the [`SignIn`](/docs/references/ - `isLoaded` - - `boolean` + - `Ref` A boolean that is set to `false` until Clerk loads and initializes. --- - `setActive()` - - (params: [SetActiveParams](#set-active-params)) => Promise\ + - Ref\<(params: [SetActiveParams](#set-active-params)) => Promise\> A function that sets the active session. --- - `signIn` - - [`SignIn`](/docs/references/javascript/sign-in/sign-in) + - Ref\<[SignIn](/docs/references/javascript/sign-in/sign-in)> An object that contains the current sign-in attempt status and methods to create a new sign-in attempt. diff --git a/docs/references/vue/use-user.mdx b/docs/references/vue/use-user.mdx index 60b16deeac..91cf5cad82 100644 --- a/docs/references/vue/use-user.mdx +++ b/docs/references/vue/use-user.mdx @@ -9,21 +9,21 @@ The `useUser()` composable is a convenient way to access the current user's [`Us - `isSignedIn` - - `boolean` + - `Ref` A boolean that returns `true` if the user is signed in. --- - `isLoaded` - - `boolean` + - `Ref` A boolean that until Clerk loads and initializes, will be set to `false`. Once Clerk loads, `isLoaded` will be set to `true`. --- - `user` - - [`User`](/docs/references/javascript/user/user) + - Ref\<[User](/docs/references/javascript/user/user)> The `User` object for the currently active user. If the user is not signed in, `user` will be `null`.