Skip to content

Commit f115e56

Browse files
authored
fix(shared): Hide billing types not needed in Typedoc (#7315)
1 parent d2a1345 commit f115e56

File tree

6 files changed

+19
-10
lines changed

6 files changed

+19
-10
lines changed

.changeset/gold-wasps-dress.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/shared': minor
3+
---
4+
5+
Hide billing types through @internal tag

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/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
/**

0 commit comments

Comments
 (0)