Skip to content

chore(backend): Add jsdoc comments for user methods #6091

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

Merged
NWylynko merged 3 commits into from
Jun 10, 2025
Merged

chore(backend): Add jsdoc comments for user methods #6091

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
54e2f69
Add jsdoc comments
NWylynko Jun 9, 2025
f2fba9f
add changeset
panteliselef Jun 10, 2025
96387be
Merge branch 'main' into nick/typedoc-add-jsdoc-for-user-methods
panteliselef Jun 10, 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
5 changes: 5 additions & 0 deletions .changeset/mean-apes-do.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Add JSdoc comments for user methods.
12 changes: 12 additions & 0 deletions packages/backend/src/api/resources/User.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
Loading