Skip to content

Commit

Permalink
fix return types
Browse files Browse the repository at this point in the history
  • Loading branch information
wobsoriano committed Dec 13, 2024
1 parent 020ada1 commit 8fca6c3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
20 changes: 10 additions & 10 deletions docs/references/vue/use-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,70 +9,70 @@ The `useAuth()` composable provides information about the current auth state, as

<Properties>
- `isSignedIn`
- `boolean`
- `Ref<boolean>`

A boolean that returns true if the user is signed in.

---

- `isLoaded`
- `boolean`
- `Ref<boolean>`

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<string>`

The current user's ID.

---

- `sessionId`
- `string`
- `Ref<string>`

The current user's session ID.

---

- `orgId`
- `string`
- `Ref<string>`

The current user's active organization ID.

---

- `orgRole`
- `string`
- `Ref<string>`

The current user's active organization role.

---

- `orgSlug`
- `string`
- `Ref<string>`

The current user's organization slug.

---

- `signOut()`
- `(options?: SignOutOptions) => Promise<void>`
- `Ref<(options?: SignOutOptions) => Promise<void>>`

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<string | null>`
- `Ref<(options?: GetTokenOptions) => Promise<string | null>>`

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.
</Properties>
Expand Down
6 changes: 3 additions & 3 deletions docs/references/vue/use-sign-in.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ The `useSignIn()` composable provides access to the [`SignIn`](/docs/references/

<Properties>
- `isLoaded`
- `boolean`
- `Ref<boolean>`

A boolean that is set to `false` until Clerk loads and initializes.

---

- `setActive()`
- <code>(params: [SetActiveParams](#set-active-params)) => Promise\<void></code>
- <code>Ref\<(params: [SetActiveParams](#set-active-params)) => Promise\<void>></code>

A function that sets the active session.

---

- `signIn`
- [`SignIn`](/docs/references/javascript/sign-in/sign-in)
- <code>Ref\<[SignIn](/docs/references/javascript/sign-in/sign-in)></code>

An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
</Properties>
Expand Down
6 changes: 3 additions & 3 deletions docs/references/vue/use-user.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@ The `useUser()` composable is a convenient way to access the current user's [`Us

<Properties>
- `isSignedIn`
- `boolean`
- `Ref<boolean>`

A boolean that returns `true` if the user is signed in.

---

- `isLoaded`
- `boolean`
- `Ref<boolean>`

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)
- <code>Ref\<[User](/docs/references/javascript/user/user)></code>

The `User` object for the currently active user. If the user is not signed in, `user` will be `null`.
</Properties>
Expand Down

0 comments on commit 8fca6c3

Please sign in to comment.