Skip to content

Commit c396b46

Browse files
committed
chore: cherry-pick Typedoc fixes and docs link update
1 parent c502481 commit c396b46

File tree

8 files changed

+17
-12
lines changed

8 files changed

+17
-12
lines changed

packages/backend/src/api/endpoints/InstanceApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ type UpdateOrganizationSettingsParams = {
5252
adminDeleteEnabled?: boolean | null | undefined;
5353
domainsEnabled?: boolean | null | undefined;
5454
/**
55-
* Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/verified-domains#enrollment-mode) to enable for your Organization Domains.
55+
* Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/verified-domains#enable-verified-domains) to enable for your Organization Domains.
5656
*
5757
* @remarks Supported modes are 'automatic_invitation' & 'automatic_suggestion'.
5858
*/

packages/shared/src/react/hooks/useAPIKeys.rq.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { createCacheKeys } from './createCacheKeys';
77
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';
88

99
/**
10-
* @interface
10+
* @internal
1111
*/
1212
export type UseAPIKeysParams = PaginatedHookConfig<
1313
GetAPIKeysParams & {
@@ -21,14 +21,16 @@ export type UseAPIKeysParams = PaginatedHookConfig<
2121
>;
2222

2323
/**
24-
* @interface
24+
* @internal
2525
*/
2626
export type UseAPIKeysReturn<T extends UseAPIKeysParams> = PaginatedResources<
2727
APIKeyResource,
2828
T extends { infinite: true } ? true : false
2929
>;
3030

3131
/**
32+
* @internal
33+
*
3234
* The `useAPIKeys()` hook provides access to paginated API keys for the current user or organization.
3335
*
3436
* @example

packages/shared/src/react/hooks/useAPIKeys.swr.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { createCacheKeys } from './createCacheKeys';
1010
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';
1111

1212
/**
13-
* @interface
13+
* @internal
1414
*/
1515
export type UseAPIKeysParams = PaginatedHookConfig<
1616
GetAPIKeysParams & {
@@ -24,14 +24,16 @@ export type UseAPIKeysParams = PaginatedHookConfig<
2424
>;
2525

2626
/**
27-
* @interface
27+
* @internal
2828
*/
2929
export type UseAPIKeysReturn<T extends UseAPIKeysParams> = PaginatedResources<
3030
APIKeyResource,
3131
T extends { infinite: true } ? true : false
3232
>;
3333

3434
/**
35+
* @internal
36+
*
3537
* The `useAPIKeys()` hook provides access to paginated API keys for the current user or organization.
3638
*
3739
* @example

packages/shared/src/react/hooks/useOrganization.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export type UseOrganizationParams = {
3131
* If set to `true`, all default properties will be used.<br />
3232
* Otherwise, accepts an object with the following optional properties:
3333
* <ul>
34-
* <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](https://clerk.com/docs/guides/organizations/verified-domains#enrollment-mode).</li>
34+
* <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](https://clerk.com/docs/guides/organizations/verified-domains#enable-verified-domains).</li>
3535
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
3636
* </ul>
3737
*/

packages/shared/src/react/hooks/usePaymentAttemptQuery.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { ClerkAPIResponseError } from '../../error';
22
import type { BillingPaymentResource, ForPayerType } from '../../types';
33

44
/**
5-
* @interface
5+
* @internal
66
*/
77
export type UsePaymentAttemptQueryParams = {
88
/**
@@ -30,7 +30,7 @@ export type UsePaymentAttemptQueryParams = {
3030
};
3131

3232
/**
33-
* @interface
33+
* @internal
3434
*/
3535
export type PaymentAttemptQueryResult = {
3636
/**

packages/shared/src/react/hooks/usePlanDetailsQuery.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { ClerkAPIResponseError } from '../../errors/clerkApiResponseError';
22
import type { BillingPlanResource } from '../../types';
33

44
/**
5-
* @interface
5+
* @internal
66
*/
77
export type UsePlanDetailsQueryParams = {
88
/**
@@ -28,7 +28,7 @@ export type UsePlanDetailsQueryParams = {
2828
};
2929

3030
/**
31-
* @interface
31+
* @internal
3232
*/
3333
export type PlanDetailsQueryResult = {
3434
/**

packages/shared/src/react/hooks/useStatementQuery.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { BillingStatementResource, ClerkAPIResponseError, ForPayerType } from '../../types';
22

33
/**
4-
* @interface
4+
* @internal
55
*/
66
export type UseStatementQueryParams = {
77
/**
@@ -29,7 +29,7 @@ export type UseStatementQueryParams = {
2929
};
3030

3131
/**
32-
* @interface
32+
* @internal
3333
*/
3434
export type StatementQueryResult = {
3535
/**

packages/shared/typedoc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"./src/react/hooks/*.{ts,tsx}",
77
"./src/react/commerce.tsx",
88
"./src/react/contexts.tsx",
9+
"./src/react/billing/*.{ts,tsx}",
910
"./src/types/*.ts"
1011
],
1112
"compilerOptions": {

0 commit comments

Comments
 (0)