clearcookies.md

title
clearCookies

Clear all browser cookies for current domain and subdomain.

{% note warning %} Cypress automatically clears all cookies before each test to prevent state from being shared across tests. You shouldn't need to use this command unless you're using it to clear a specific cookie inside a single test. {% endnote %}

Syntax

cy.clearCookies()
cy.clearCookies(options)

Usage

{% fa fa-check-circle green %} Correct Usage

cy.clearCookies()     // clear all cookies

Arguments

{% fa fa-angle-right %} options (Object)

Pass in an options object to change the default behavior of cy.clearCookies().

Option	Default	Description
log	true	{% usage_options log %}
timeout	{% url responseTimeout configuration#Timeouts %}	{% usage_options timeout cy.clearCookies %}

Yields {% helper_icon yields %}

{% yields null cy.clearCookies %}

Examples

No Args

Clear all cookies after logging in

In this example, on first login our server sends us back a session cookie. After invoking cy.clearCookies() this clears the session cookie, and upon navigating to an unauthorized page, our server should have redirected us back to login.

// assume we just logged in
cy.contains('Login').click()
cy.url().should('include', 'profile')
cy.clearCookies()
cy.visit('/dashboard') // we should be redirected back to login
cy.url().should('include', 'login')

Rules

Requirements {% helper_icon requirements %}

{% requirements parent cy.clearCookies %}

Assertions {% helper_icon assertions %}

{% assertions none cy.clearCookies %}

Timeouts {% helper_icon timeout %}

{% timeouts automation cy.clearCookies %}

Command Log

Clear cookies after getting cookies

cy.getCookies().should('have.length', 1)
cy.clearCookies()
cy.getCookies().should('be.empty')

The commands above will display in the Command Log as:

{% imgTag /img/api/clearcookies/clear-all-cookies-in-cypress-tests.png "Command Log" %}

When clicking on clearCookies within the command log, the console outputs the following:

{% imgTag /img/api/clearcookies/inspect-cleared-cookies-in-console.png "Console Log" %}

See also

• {% url cy.clearCookie() clearcookie %}
• {% url 'Cypress Cookies API' cookies %}
• {% url cy.getCookie() getcookie %}
• {% url cy.getCookies() getcookies %}
• {% url cy.setCookie() setcookie %}