Skip to main content

request.logoutCustomer

Logout the currently logged-in customer (frontend user). This function is available on the Express request object.

Import​

import { EvershopRequest } from "@evershop/evershop/types/request";
import { EvershopResponse } from "@evershop/evershop/types/response";

Syntax​

request.logoutCustomer(): void

Parameters​

None.

Return Value​

Returns void.

Description​

Clears the customer session and local customer data. After calling this method:

  • request.session.customerID is set to undefined
  • request.locals.customer is set to undefined
  • request.isCustomerLoggedIn() will return false

Examples​

Basic Logout​

export default async function logoutMiddleware(request, response) {
  request.logoutCustomer();
  response.json({ success: true });
}

Logout with Redirect​

export default async function logoutMiddleware(request, response) {
  request.logoutCustomer();
  response.redirect('/');
}

See Also​