Skip to content

[ci] Update Typedoc (f95ffdc) #2849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SarahSoutoul merged 2 commits into from
Dec 2, 2025
Merged

[ci] Update Typedoc (f95ffdc) #2849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1953371
docs: update TypeDoc documentation from clerk/javascript@f95ffdc
github-actions[bot] Dec 1, 2025
92a2bd5
Merge branch 'main' into typedoc-f95ffdc
SarahSoutoul Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clerk-typedoc/clerk-react/clerk-provider-props.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
| <a id="signupurl"></a> `signUpUrl?` | `string` | This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances but **must be set for a satellite application in a development instance**. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |
| <a id="standardbrowser"></a> `standardBrowser?` | `boolean` | By default, ClerkJS is loaded with the assumption that cookies can be set (browser setup). On native platforms this value must be set to `false`. |
| <a id="supportemail"></a> `supportEmail?` | `string` | Optional support email for display in authentication screens. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. |
| <a id="taskurls"></a> `taskUrls?` | `Record`\<`"choose-organization"`, `string`\> | Customize the URL paths users are redirected to after sign-in or sign-up when specific session tasks need to be completed. When `undefined`, it uses Clerk's default task flow URLs. Defaults to `undefined`. |
| <a id="taskurls"></a> `taskUrls?` | `Record`\<<code>"choose-organization" \| "reset-password"</code>, `string`\> | Customize the URL paths users are redirected to after sign-in or sign-up when specific session tasks need to be completed. When `undefined`, it uses Clerk's default task flow URLs. Defaults to `undefined`. |
| <a id="telemetry"></a> `telemetry?` | <code>false \| \{ debug?: boolean; disabled?: boolean; perEventSampling?: boolean; \}</code> | Controls whether or not Clerk will collect [telemetry data](/docs/guides/how-clerk-works/security/clerk-telemetry). If set to `debug`, telemetry events are only logged to the console and not sent to Clerk. |
| <a id="touchsession"></a> `touchSession?` | `boolean` | By default, the [Clerk Frontend API `touch` endpoint](/docs/reference/frontend-api/tag/Sessions#operation/touchSession) is called during page focus to keep the last active session alive. This option allows you to disable this behavior. |
| <a id="waitlisturl"></a> `waitlistUrl?` | `string` | The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/guides/customizing-clerk/account-portal#waitlist). |
6 changes: 3 additions & 3 deletions clerk-typedoc/shared/session-task.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ Represents the current pending task of a session.

## Properties

| Property | Type | Description |
| ---------------------- | ----------------------- | -------------------------------- |
| <a id="key"></a> `key` | `"choose-organization"` | A unique identifier for the task |
| Property | Type | Description |
| ---------------------- | ------------------------------------------------------ | -------------------------------- |
| <a id="key"></a> `key` | <code>"choose-organization" \| "reset-password"</code> | A unique identifier for the task |
2 changes: 1 addition & 1 deletion clerk-typedoc/shared/use-organization-params.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
| Property | Type | Description |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="domains"></a> `domains?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/verified-domains#enrollment-mode).</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
| <a id="domains"></a> `domains?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/verified-domains#enable-verified-domains).</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
| <a id="invitations"></a> `invitations?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "pending" \| "accepted" \| "revoked")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`status`: A string that filters the invitations by the provided status.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
| <a id="membershiprequests"></a> `membershipRequests?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`status`: A string that filters the membership requests by the provided status.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |
| <a id="memberships"></a> `memberships?` | <code>true \| \{ initialPage?: number; pageSize?: number; \} & \{ query?: string; role?: string[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \}</code> | If set to `true`, all default properties will be used.<br /> Otherwise, accepts an object with the following optional properties: <ul> <li>`role`: An array of [`OrganizationCustomRoleKey`](/docs/reference/javascript/types/organization-custom-role-key).</li> <li>`query`: A string that filters the memberships by the provided string.</li> <li>Any of the properties described in [Shared properties](#shared-properties).</li> </ul> |