Skip to content

Commit 4d15017

Browse files
github-actions[bot]SarahSoutoul
github-actions[bot]
and
SarahSoutoul
authored
[ci] Update Typedoc (f95ffdc) (#2849)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Sarah Soutoul <sarah@clerk.dev>
1 parent a83ea2c commit 4d15017

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

‎clerk-typedoc/clerk-react/clerk-provider-props.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
| <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. |
3838
| <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`. |
3939
| <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. |
40-
| <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`. |
40+
| <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`. |
4141
| <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. |
4242
| <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. |
4343
| <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). |

‎clerk-typedoc/shared/session-task.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ Represents the current pending task of a session.
22

33
## Properties
44

5-
| Property | Type | Description |
6-
| ---------------------- | ----------------------- | -------------------------------- |
7-
| <a id="key"></a> `key` | `"choose-organization"` | A unique identifier for the task |
5+
| Property | Type | Description |
6+
| ---------------------- | ------------------------------------------------------ | -------------------------------- |
7+
| <a id="key"></a> `key` | <code>"choose-organization" \| "reset-password"</code> | A unique identifier for the task |

‎clerk-typedoc/shared/use-organization-params.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
| Property | Type | Description |
22
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3-
| <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> |
3+
| <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> |
44
| <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> |
55
| <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> |
66
| <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> |

0 commit comments

Comments
 (0)