Skip to content

Commit c7b0f47

Browse files
authored
fix(shared): Add additional fields to signUp.update (#8320)
1 parent 6399251 commit c7b0f47

2 files changed

Lines changed: 24 additions & 3 deletions

File tree

.changeset/green-sides-tickle.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/shared': patch
3+
---
4+
5+
Add `emailAddress`, `phoneNumber`, and `username` support to `signUp.update()`

packages/shared/src/types/signUpFuture.ts

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,25 @@ export interface SignUpFutureCreateParams extends SignUpFutureAdditionalParams {
9898
web3Wallet?: string;
9999
}
100100

101-
// This will likely get more properties
102-
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
103-
export interface SignUpFutureUpdateParams extends SignUpFutureAdditionalParams {}
101+
export interface SignUpFutureUpdateParams extends SignUpFutureAdditionalParams {
102+
/**
103+
* The user's email address. Only supported if [Email address](https://clerk.com/docs/guides/configure/auth-strategies/sign-up-sign-in-options#email)
104+
* is enabled. Keep in mind that the email address requires an extra verification process.
105+
*/
106+
emailAddress?: string;
107+
/**
108+
* The user's phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). Only supported if
109+
* [phone number](https://clerk.com/docs/guides/configure/auth-strategies/sign-up-sign-in-options#phone) is enabled.
110+
* Keep in mind that the phone number requires an extra verification process.
111+
*/
112+
phoneNumber?: string;
113+
/**
114+
* The user's username. Only supported if
115+
* [username](https://clerk.com/docs/guides/configure/auth-strategies/sign-up-sign-in-options#username) is enabled in
116+
* the instance settings.
117+
*/
118+
username?: string;
119+
}
104120

105121
export interface SignUpFutureEmailCodeVerifyParams {
106122
/**

0 commit comments

Comments
 (0)