[ci] Update Typedoc (4abbf4d) #2488
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This was referenced Aug 12, 2025
NWylynko
reviewed
Aug 12, 2025
| @@ -16,7 +16,7 @@ | |||
| | <a id="experimental"></a> `experimental?` | `Autocomplete`\<<code>\{ commerce: boolean; persistClient: boolean; rethrowOfflineNetworkErrors: boolean; \}</code>, `Record`\<`string`, `any`\>\> | Enable experimental flags to gain access to new features. These flags are not guaranteed to be stable and may change drastically in between patch or minor versions. | | |||
| | <a id="initialstate"></a> `initialState?` | `Serializable`\<<code>\{ actor: undefined \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: \[number, number\]; organization: undefined \| [OrganizationResource](/docs/references/javascript/organization); orgId: undefined \| string; orgPermissions: undefined \| string[]; orgRole: undefined \| string; orgSlug: undefined \| string; session: undefined \| [SessionResource](/docs/references/javascript/session); sessionClaims: JwtPayload; sessionId: undefined \| string; sessionStatus: [SessionStatusClaim](/docs/references/javascript/types/session-status); user: undefined \| [UserResource](/docs/references/javascript/user); userId: undefined \| string; \}</code>\> | Provide an initial state of the Clerk client during server-side rendering. You don't need to set this value yourself unless you're [developing an SDK](/docs/references/sdk/overview). | | |||
| | <a id="issatellite"></a> `isSatellite?` | <code>boolean \| (url) => boolean</code> | A boolean that indicates whether the application is a satellite application. | | |||
| | <a id="localization"></a> `localization?` | `DeepPartial`\<[Localization](/docs/customization/localization)\> | Optional object to localize your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/account-portal/overview) pages. | | |||
| | <a id="localization"></a> `localization?` | `DeepPartial`\<`DeepLocalizationWithoutObjects`\<`__internal_LocalizationResource`\>\> | Optional object to localize your components. Will only affect [Clerk Components](/docs/components/overview) and not [Account Portal](/docs/account-portal/overview) pages. | | |||
There was a problem hiding this comment.
This is a regression in the docs, used to be linked [Localization](/docs/customization/localization) now its not
There was a problem hiding this comment.
NWylynko
reviewed
Aug 12, 2025
| @@ -36,3 +36,67 @@ The Backend `User` object is similar to the `User` object as it holds informatio | |||
| | <a id="updatedat"></a> `updatedAt` | `number` | The date when the user was last updated. | | |||
| | <a id="username"></a> `username` | <code>null \| string</code> | The user's username. | | |||
| | <a id="web3wallets"></a> `web3Wallets` | <code>[Web3Wallet](/docs/references/backend/types/backend-web3-wallet)[]</code> | An array of all the `Web3Wallet` objects associated with the user. Includes the primary. | | |||
|
|
|||
| ## Accessors | |||
There was a problem hiding this comment.
These accessors markdown processing is completely broken, needs to be processed in to a table
There was a problem hiding this comment.
NWylynko
reviewed
Aug 12, 2025
| @@ -7,4 +7,4 @@ | |||
| | <a id="membershiprequests"></a> `membershipRequests` | <code>null \| PaginatedResourcesWithDefault\<[OrganizationMembershipRequestResource](/docs/references/javascript/types/organization-membership-request)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipRequestResource](/docs/references/javascript/types/organization-membership-request), T\["membershipRequests"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Includes a paginated list of the organization's membership requests. | | |||
| | <a id="memberships"></a> `memberships` | <code>null \| PaginatedResourcesWithDefault\<[OrganizationMembershipResource](/docs/references/javascript/types/organization-membership)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipResource](/docs/references/javascript/types/organization-membership), T\["memberships"\] _extends_ \{ infinite: true; \} ? true : false\></code> | Includes a paginated list of the organization's memberships. | | |||
| | <a id="organization"></a> `organization` | <code>undefined \| null \| [OrganizationResource](/docs/references/javascript/organization)</code> | The currently active organization. | | |||
| | <a id="subscriptions"></a> `subscriptions` | <code>null \| PaginatedResourcesWithDefault\<[CommerceSubscriptionResource](../types/commerce-subscription-resource.mdx)\> \| [PaginatedResources](#paginated-resources)\<[CommerceSubscriptionResource](../types/commerce-subscription-resource.mdx), T\["subscriptions"\] _extends_ \{ infinite: true; \} ? true : false\></code> | **`Experimental`** This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. Includes a paginated list of the organization's subscriptions. | | |||
| | <a id="subscriptions"></a> `subscriptions` | <code>null \| PaginatedResourcesWithDefault\<[CommerceSubscriptionItemResource](../types/commerce-subscription-item-resource.mdx)\> \| [PaginatedResources](#paginated-resources)\<[CommerceSubscriptionItemResource](../types/commerce-subscription-item-resource.mdx), T\["subscriptions"\] _extends_ \{ infinite: true; \} ? true : false\></code> | **`Experimental`** This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. Includes a paginated list of the organization's subscriptions. | | |||
There was a problem hiding this comment.
The link ../types/commerce-subscription-item-resource.mdx is broken, it points to /docs/nextjs/types/commerce-subscription-item-resource.mdx which 404s
There was a problem hiding this comment.
9 tasks
|
Closed because of new typedoc pr #2496 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Auto-generated PR to update Typedoc documentation from clerk/javascript@4abbf4d
Pages using updated typedoc markdown