File tree Expand file tree Collapse file tree
packages/shared/src/types Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ ---
2+ ' @clerk/shared ' : patch
3+ ---
4+
5+ Add ` emailAddress ` , ` phoneNumber ` , and ` username ` support to ` signUp.update() `
Original file line number Diff line number Diff 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
105121export interface SignUpFutureEmailCodeVerifyParams {
106122 /**
You can’t perform that action at this time.
0 commit comments