diff --git a/.changeset/mean-apes-do.md b/.changeset/mean-apes-do.md new file mode 100644 index 00000000000..77c90043d60 --- /dev/null +++ b/.changeset/mean-apes-do.md @@ -0,0 +1,5 @@ +--- +'@clerk/backend': patch +--- + +Add JSdoc comments for user methods. diff --git a/packages/backend/src/api/resources/User.ts b/packages/backend/src/api/resources/User.ts index 1f5c93c7aff..8c03c168318 100644 --- a/packages/backend/src/api/resources/User.ts +++ b/packages/backend/src/api/resources/User.ts @@ -185,18 +185,30 @@ export class User { return res; } + /** + * The primary email address of the user. + */ get primaryEmailAddress() { return this.emailAddresses.find(({ id }) => id === this.primaryEmailAddressId) ?? null; } + /** + * The primary phone number of the user. + */ get primaryPhoneNumber() { return this.phoneNumbers.find(({ id }) => id === this.primaryPhoneNumberId) ?? null; } + /** + * The primary web3 wallet of the user. + */ get primaryWeb3Wallet() { return this.web3Wallets.find(({ id }) => id === this.primaryWeb3WalletId) ?? null; } + /** + * The full name of the user. + */ get fullName() { return [this.firstName, this.lastName].join(' ').trim() || null; }