Skip to content

[ci] Update Typedoc (9abb76f) #2772

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

Closed
wants to merge 3 commits into from
Closed

[ci] Update Typedoc (9abb76f) #2772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d55afc3
docs: update TypeDoc documentation from clerk/javascript@9abb76f
github-actions[bot] Nov 6, 2025
482d83a
Bring in typedoc changes on docs
SarahSoutoul Nov 6, 2025
4b9b6fa
Merge branch 'main' into typedoc-9abb76f
SarahSoutoul Nov 6, 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
12 changes: 6 additions & 6 deletions clerk-typedoc/backend/auth-object.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Properties

| Property | Type | Description |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="debug"></a> `debug` | <code>() => \{ [key: string]: any; \}</code> | Used to help debug issues when using Clerk in development. |
| <a id="gettoken"></a> `getToken` | <code>() => Promise\<null\> \| () => Promise\<string\> \| [ServerGetToken](../types/server-get-token.mdx) \| () => Promise\<null\></code> | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). |
| <a id="has"></a> `has` | <code>[CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx) \| () => false</code> | A function that checks if the user has an organization role or custom permission. |
| <a id="tokentype"></a> `tokenType` | <code>null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token"</code> | The allowed token type. |
| Property | Type | Description |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="debug"></a> `debug` | <code>() => \{ [key: string]: any; \}</code> | Used to help debug issues when using Clerk in development. |
| <a id="gettoken"></a> `getToken` | <code>() => Promise\<null\> \| () => Promise\<string\> \| ServerGetToken \| () => Promise\<null\></code> | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). |
| <a id="has"></a> `has` | <code>CheckAuthorizationFromSessionClaims \| () => false</code> | A function that checks if the user has an organization role or custom permission. |
Copy link
Contributor

@NWylynko NWylynko Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lost a link here

Copy link
Contributor

@SarahSoutoul SarahSoutoul Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having a look rn

Copy link
Contributor

@SarahSoutoul SarahSoutoul Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links were broken in the first place, as there aren't links in the first place to link these too. This is also a typedoc that's not being used as we discussed. So I think we're safe to ignore.

| <a id="tokentype"></a> `tokenType` | <code>null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token"</code> | The allowed token type. |
38 changes: 19 additions & 19 deletions clerk-typedoc/backend/billing-subscription-item.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@ The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItem

## Properties

| Property | Type | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| <a id="amount"></a> `amount` | <code>undefined \| null \| [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code> | The current amount for the subscription item. |
| <a id="canceledat"></a> `canceledAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription item was canceled. |
| <a id="createdat"></a> `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was created. |
| <a id="endedat"></a> `endedAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription item ended. |
| <a id="id"></a> `id` | `string` | The unique identifier for the subscription item. |
| <a id="isfreetrial"></a> `isFreeTrial?` | `boolean` | Whether this subscription item is currently in a free trial period. |
| <a id="lifetimepaid"></a> `lifetimePaid?` | <code>null \| [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount)</code> | The lifetime amount paid for this subscription item. |
| <a id="nextpayment"></a> `nextPayment` | <code>null \| \{ amount: number; date: number; \}</code> | The next payment information. |
| <a id="pastdueat"></a> `pastDueAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription item became past due. |
| <a id="payerid"></a> `payerId` | `string` | The payer ID. |
| <a id="periodend"></a> `periodEnd` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the current period ends. |
| <a id="periodstart"></a> `periodStart` | `number` | Unix timestamp (milliseconds) of when the current period starts. |
| <a id="plan"></a> `plan` | <code>null \| [BillingPlan](billing-plan.mdx)</code> | The plan associated with this subscription item. |
| <a id="planid"></a> `planId` | <code>null \| string</code> | The plan ID. |
| <a id="planperiod"></a> `planPeriod` | <code>"month" \| "annual"</code> | The plan period for the subscription item. |
| <a id="status"></a> `status` | `BillingSubscriptionItemStatus` | The status of the subscription item. |
| <a id="updatedat"></a> `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was last updated. |
| Property | Type | Description |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| <a id="amount"></a> `amount` | <code>undefined \| null \| [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount)</code> | The current amount for the subscription item. |
| <a id="canceledat"></a> `canceledAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription item was canceled. |
| <a id="createdat"></a> `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was created. |
| <a id="endedat"></a> `endedAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription item ended. |
| <a id="id"></a> `id` | `string` | The unique identifier for the subscription item. |
| <a id="isfreetrial"></a> `isFreeTrial?` | `boolean` | Whether this subscription item is currently in a free trial period. |
| <a id="lifetimepaid"></a> `lifetimePaid?` | <code>null \| [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount)</code> | The lifetime amount paid for this subscription item. |
| <a id="nextpayment"></a> `nextPayment` | <code>null \| \{ amount: number; date: number; \}</code> | The next payment information. |
| <a id="pastdueat"></a> `pastDueAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription item became past due. |
| <a id="payerid"></a> `payerId` | `string` | The payer ID. |
| <a id="periodend"></a> `periodEnd` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the current period ends. |
| <a id="periodstart"></a> `periodStart` | `number` | Unix timestamp (milliseconds) of when the current period starts. |
| <a id="plan"></a> `plan` | <code>null \| [BillingPlan](billing-plan.mdx)</code> | The plan associated with this subscription item. |
| <a id="planid"></a> `planId` | <code>null \| string</code> | The plan ID. |
| <a id="planperiod"></a> `planPeriod` | <code>"month" \| "annual"</code> | The plan period for the subscription item. |
| <a id="status"></a> `status` | `BillingSubscriptionItemStatus` | The status of the subscription item. |
| <a id="updatedat"></a> `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was last updated. |
24 changes: 12 additions & 12 deletions clerk-typedoc/backend/billing-subscription.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ The `BillingSubscription` object is similar to the [`BillingSubscriptionResource

## Properties

| Property | Type | Description |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| <a id="activeat"></a> `activeAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription became active. |
| <a id="createdat"></a> `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription was created. |
| <a id="eligibleforfreetrial"></a> `eligibleForFreeTrial` | `boolean` | Whether the payer is eligible for a free trial. |
| <a id="id"></a> `id` | `string` | The unique identifier for the billing subscription. |
| <a id="nextpayment"></a> `nextPayment` | <code>null \| \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); date: number; \}</code> | Information about the next scheduled payment. |
| <a id="pastdueat"></a> `pastDueAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription became past due. |
| <a id="payerid"></a> `payerId` | `string` | The ID of the payer for this subscription. |
| <a id="status"></a> `status` | <code>"abandoned" \| "active" \| "ended" \| "canceled" \| "incomplete" \| "past_due"</code> | The current status of the subscription. |
| <a id="subscriptionitems"></a> `subscriptionItems` | <code>[BillingSubscriptionItem](billing-subscription-item.mdx)[]</code> | Array of subscription items in this subscription. |
| <a id="updatedat"></a> `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription was last updated. |
| Property | Type | Description |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| <a id="activeat"></a> `activeAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription became active. |
| <a id="createdat"></a> `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription was created. |
| <a id="eligibleforfreetrial"></a> `eligibleForFreeTrial` | `boolean` | Whether the payer is eligible for a free trial. |
| <a id="id"></a> `id` | `string` | The unique identifier for the billing subscription. |
| <a id="nextpayment"></a> `nextPayment` | <code>null \| \{ amount: [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount); date: number; \}</code> | Information about the next scheduled payment. |
| <a id="pastdueat"></a> `pastDueAt` | <code>null \| number</code> | Unix timestamp (milliseconds) of when the subscription became past due. |
| <a id="payerid"></a> `payerId` | `string` | The ID of the payer for this subscription. |
| <a id="status"></a> `status` | <code>"abandoned" \| "active" \| "ended" \| "canceled" \| "incomplete" \| "past_due"</code> | The current status of the subscription. |
| <a id="subscriptionitems"></a> `subscriptionItems` | <code>[BillingSubscriptionItem](billing-subscription-item.mdx)[]</code> | Array of subscription items in this subscription. |
Copy link
Contributor

@NWylynko NWylynko Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a broken link / missing a link replacement

Copy link
Contributor

@SarahSoutoul SarahSoutoul Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure of this one bcs of several reasons:

  1. It's not being used as a typedoc.
  2. It's only being used in this typedoc.
  3. There is no existing link to link this to.

| <a id="updatedat"></a> `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription was last updated. |
Loading