Skip to content

setcookie.md

Latest commit

 

History

History
114 lines (77 loc) · 3.23 KB

setcookie.md

File metadata and controls

114 lines (77 loc) · 3.23 KB
title setCookie

Set a browser cookie.

Syntax

cy.setCookie(name, value)
cy.setCookie(name, value, options)

Usage

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

cy.setCookie('auth_key', '123key') // Set the 'auth_key' cookie to '123key'

Arguments

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

The name of the cookie to set.

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

The value of the cookie to set.

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

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

Option Default Description
log true {% usage_options log %}
domain window.location.hostname The domain the cookie is visible to
expiry 20 years into the future When the cookie expires, specified in seconds since {% url 'Unix Epoch' https://en.wikipedia.org/wiki/Unix_time %}.
httpOnly false Whether the cookie is an HTTP only cookie
path / The cookie path
secure false Whether the cookie is a secure cookie
timeout {% url responseTimeout configuration#Timeouts %} {% usage_options timeout cy.setCookie %}
sameSite undefined Cookie's SameSite value. If set, should be one of lax, strict, or no_restriction. Pass undefined to use the browser's default. Note: no_restriction can only be used if the secure flag is set to true.

Yields {% helper_icon yields %}

cy.setCookie() yields a cookie object with the following properties:

  • domain
  • expiry (if specified)
  • httpOnly
  • name
  • path
  • sameSite (if specified)
  • secure
  • value

Examples

Name Value

Set a cookie

cy.getCookies().should('be.empty')
cy.setCookie('session_id', '189jd09sufh33aaiidhf99d09')
cy.getCookie('session_id').should('have.property', 'value', '189jd09sufh33aaiidhf99d09')

Rules

Requirements {% helper_icon requirements %}

{% requirements parent cy.setCookie %}

Assertions {% helper_icon assertions %}

{% assertions once cy.setCookie %}

Timeouts {% helper_icon timeout %}

{% timeouts automation cy.setCookie %}

Command Log

cy.getCookies().should('be.empty')
cy.setCookie('fakeCookie1', '123ABC')
cy.getCookie('fakeCookie1').should('have.property', 'value', '123ABC')

The commands above will display in the Command Log as:

{% imgTag /img/api/setcookie/set-cookie-on-browser-for-testing.png "Command Log setcookie" %}

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

{% imgTag /img/api/setcookie/see-cookie-properties-expiry-domain-and-others-in-test.png "Console Log setcookie" %}

{% history %} {% url "5.0.0" changelog#5-0-0 %} | Removed experimentalGetCookiesSameSite and made sameSite property always available. {% url "4.3.0" changelog#4-3-0 %} | Added sameSite property when the {% url "experimentalGetCookiesSameSite" configuration#Experiments %} configuration value is true. {% url "0.16.0" changelog#0-16-0 %} | cy.setCookie() command added {% endhistory %}

See also

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