Skip to content

Commit 98fd223

Browse files
committed
Fix duplicate returns APIKeys
1 parent 2e98fbf commit 98fd223

2 files changed

Lines changed: 3 additions & 2 deletions

File tree

.typedoc/extract-methods.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1295,7 +1295,7 @@ function buildMethodMdx(decl, ctx, options = {}) {
12951295
/** Prefer the declaration comment (property-style methods document `addListener` on the property, not the signature). */
12961296
const comment = decl.comment ?? sig.comment;
12971297
let description = commentSummaryAndBody(comment);
1298-
const sigReturns = appendSignatureOnlyReturns(decl.comment, sig.comment);
1298+
const sigReturns = comment === sig.comment ? '' : appendSignatureOnlyReturns(decl.comment, sig.comment);
12991299
if (sigReturns) {
13001300
description = [description, sigReturns].filter(Boolean).join('\n\n');
13011301
}

packages/shared/src/types/apiKeys.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,14 @@ export interface APIKeysNamespace {
8383
getAll(params?: GetAPIKeysParams): Promise<ClerkPaginatedResponse<APIKeyResource>>;
8484
/**
8585
* Creates a new API key. **The secret is only available in the response from `create()` and cannot be retrieved later.**
86-
* @returns A [`APIKeyResource`](https://clerk.com/docs/reference/types/api-key-resource) object that includes the `secret` property.
86+
* @returns An [`APIKeyResource`](https://clerk.com/docs/reference/types/api-key-resource) object that includes the `secret` property.
8787
* > [!WARNING]
8888
* > Make sure to store the API key secret immediately after creation, as it will not be available again.
8989
*/
9090
create(params: CreateAPIKeyParams): Promise<APIKeyResource>;
9191
/**
9292
* Revokes a given API key by ID.
93+
* @returns An [`APIKeyResource`](https://clerk.com/docs/reference/types/api-key-resource) object.
9394
*/
9495
revoke(params: RevokeAPIKeyParams): Promise<APIKeyResource>;
9596
}

0 commit comments

Comments
 (0)