Function changeUserEmailHandler

  • changeUserEmailHandler(authAPI, userService, changeEmailSuccessConfig, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Update user email info handler

    Parameters

    • authAPI: Pick<AuthDefaultAdapterAPI, "generateOnetimeToken">
    • userService: UserDataService

      injected service use to handle the user related operations

      • updateUser
    • changeEmailSuccessConfig: PasswordEmailConfig & {
          mailService?: MailService;
          sender: string;
      }
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query]. Note:

      • params.id is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status OK

    • data: updated user info

    Description

    This handler will update user info by applying the following steps in sequence:

    1. Get userId from context.params

    2. Update user email (userService.updateUser)

    3. Get user by id (userService.getUserById)

    4. Normalize user response (normalizeUserResponse)

    5. Return user

    Throws

    404 NBError Not Found

    • userId not defined

    Throws

    409 Conflict

    • email is already being used

    Throws

    500 NBError Internal Server Error

    • normalizeUser error

Settings

Member Visibility

Theme

Generated using TypeDoc