Interface SignupMembers

screen

transaction

signup

• signup(payload: SignupPayloadOptions): Promise<void>

  Parameters

  • payload: SignupPayloadOptions

  Returns Promise<void>

federatedSignup

• federatedSignup(payload: FederatedSignupPayloadOptions): Promise<void>

  Parameters

  • payload: FederatedSignupPayloadOptions

  Returns Promise<void>

pickCountryCode

• pickCountryCode(payload?: CustomOptions): Promise<void>

  Parameters

  • Optionalpayload: CustomOptions

  Returns Promise<void>

validatePassword

• validatePassword(password: string): PasswordValidationResult

  Parameters

  • password: string

  Returns PasswordValidationResult

getSignupIdentifiers

• getSignupIdentifiers(): Identifier[] | null

  Returns a list of enabled identifiers (e.g. email, phone, username) based on the current transaction state.

  Identifiers may be required or optional depending on the connection strategy and configuration provided during the authentication or signup flow.

  Returns Identifier[] | null

  An array of enabled Identifier objects, or null if the transaction is not initialized.

  Example

  const identifiers = authClient.getSignupIdentifiers();
  if (identifiers) {
    identifiers.forEach(({ type, required }) => {
      console.log(`${type} is ${required ? 'required' : 'optional'}`);
    });
  }
  Copy

  Utility Feature

  See

  Identifier

validateUsername

• validateUsername(username: string): UsernameValidationResult

  Parameters

  • username: string

  Returns UsernameValidationResult