useAuth

The useAuth hook returns information about the current authentication session, and functions for authentication with a Shopify customer account.

The useAuth hook returns an object with these properties:

The getToken function retrieves the current Shopify customer access token, and adds it the Redux store. While you are unlikely to need the token directly, since the SDK automatically appends it to relevant Shopify API requests, you can use this function to check whether the user's session is still active. If the user's session has expired, getToken will throw an error.

You may choose to call getToken on page load or when a user visits a protected route (like an account page) to check that their session has not expired since the last time you checked.

Arguments:

None.

Returns:

Promise<String>: A Promise that resolves with the Shopify customer access token.

Example:

The login function should be called when a user submits a login form. It submits the email address and password for a Shopify customer and initiates an authentication session. This method creates a Shopify customer access token.

Arguments:

login({ email, password })

Returns:

Promise<void>: A Promise that resolves when the user has been logged in.

Example:

The logout function terminates the user's current session. This method destroys the current Shopify customer access token.

Arguments:

None.

Returns:

Promise<void>: A Promise that resolves when the session has been cleared.

Example:

The recover function sends a Shopify reset password email to the customer.

Arguments:

recover(email)

Returns:

Promise<void>: A Promise that resolves when the reset password email has been sent.

Example:

The register function creates a new Shopify customer and initiates an authentication session. This also creates a Shopify customer access token.

Arguments:

register({ email, password })

Returns:

Promise<void>: A Promise that resolves when the user has been registered and logged in.

Example:

The resetPassword function resets a Shopify customer’s password with an ID and token from a Shopify reset password email.

Arguments:

resetPassword({ id, password, token })

Returns:

Promise<void>: A Promise that resolves when the user has been logged in.

Example: