cypress/docs/source/api/commands/clearcookie.md

title, comments

title	comments
clearCookie	false

Clear a specific browser cookie.

{% 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 all cookies inside a single test. {% endnote %}

Syntax

cy.clearCookie(name)
cy.clearCookie(name, options)

Usage

cy.clearCookie() cannot be chained off any other cy commands, so should be chained off of cy for clarity.

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

cy.clearCookie('authId')    // clear the 'authId' cookie

Arguments

{% fa fa-angle-right %} name (String)

The name of the cookie to be cleared.

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

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

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

Yields {% helper_icon yields %}

{% yields null cy.clearCookie %}

Requirements {% helper_icon defaultAssertion %}

{% requirements none cy.clearCookie %}

Timeouts {% helper_icon timeout %}

{% timeouts automation cy.clearCookie %}

Examples

Clear Cookie

Clear a cookie after logging in

In this example, on first login, our server sends us back a session cookie. After invoking cy.clearCookie('session_id'), this clears the session cookie. Then upon navigating to an unauthorized page, we asset that our server has redirected us back to login.

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

Command Log

Clearing a cookie after setting a cookie

cy.setCookie('foo', 'bar')
cy.clearCookie('foo')
cy.getCookie('foo').should('be.null')

The commands above will display in the command log as:

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

See also

• {% url cy.clearCookies() clearcookies %}
• {% url cy.clearLocalStorage() clearlocalstorage %}
• {% url 'Cypress Cookies API' cookies %}
• {% url cy.getCookie() getcookie %}
• {% url cy.getCookies() getcookies %}
• {% url cy.setCookie() setcookie %}