Skip to content

Commit 3c35688

Browse files
authored
docs(repo): Fix Core 3 Typedoc outputs (#7966)
1 parent 551fcc8 commit 3c35688

4 files changed

Lines changed: 8 additions & 5 deletions

File tree

.changeset/rich-swans-wait.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

.typedoc/custom-plugin.mjs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ const FILES_WITHOUT_HEADINGS = [
3434
'use-reverification-params.mdx',
3535
'payment-element-provider-props.mdx',
3636
'payment-element-props.mdx',
37+
'use-organization-creation-defaults-return.mdx',
38+
'use-organization-creation-defaults-params.mdx',
3739
];
3840

3941
/**

packages/react/src/hooks/useClerkSignal.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ function useClerkSignal(
7373
}
7474

7575
/**
76+
* @internal
77+
*
7678
* This hook allows you to access the Signal-based `SignIn` resource.
7779
*
7880
* @example
@@ -90,6 +92,8 @@ export function useSignIn() {
9092
}
9193

9294
/**
95+
* @internal
96+
*
9397
* This hook allows you to access the Signal-based `SignUp` resource.
9498
*
9599
* @example

packages/shared/src/types/hooks.ts

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,6 @@ export type UseAuthReturn =
7171
signOut: SignOut;
7272
/**
7373
* A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/reference/javascript/session#get-token).
74-
*
75-
* > [!NOTE]
76-
* > To access auth data server-side, see the [`Auth` object reference doc](https://clerk.com/docs/reference/backend/types/auth-object).
77-
*
78-
* @throws {ClerkRuntimeError} When called in a non-browser environment (code: `clerk_runtime_not_browser`)
7974
*/
8075
getToken: GetToken;
8176
}

0 commit comments

Comments
 (0)