Skip to main content



isError required boolean


true if an error occurred


use !isSuccess or !!error instead

error required null | ErrorPayload

Provides details about the error

isLoading required boolean


true when the action is executing, false when it finished its execution.

isSuccess required boolean

Returns true if the action is successful.

user required null | User

User information

accessToken required null | string

Access token (JWT)

needsEmailVerification required boolean


true if an email is required to complete the action, and that a verification email has been sent to complete the action.

signUpEmailPassword required SignUpEmailPasswordHandler

Used for a new user to sign up. Returns a promise with the current context