Skip to main content

​
Overview

useUpdateUserPasswordWithCurrentPassword hook is used to handle the process of updating a user’s password using their current password. It leverages the react-query library to manage the asynchronous operation and provides error handling and success callbacks.
After changing the user’s password, their session will be terminated, and they will need to log in again using the new password.

​
Parameters

​
onSuccess
() => void
required
callback function that is called when the password update process is successful.
​
onError
HttpErrorCallback
required
callback function that is called when an error occurs during the password update process.

​
Returns

​
updateUserPassword
(payload: UpdatePasswordUsingCurrentPassword) => void
function that triggers the password update process with the provided payload.
UpdatePasswordUsingCurrentPassword type
type UpdatePasswordUsingCurrentPassword = {
  currentPassword: string;
  newPassword: string;
};
​
isLoading
boolean
boolean indicating whether the password update process is currently in progress.
​
isError
boolean
boolean indicating whether an error occurred during the password update process.
​
error
HttpError | Error | null
error object if an error occurred during the password update process.