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

title, comments

title	comments
setCookie	false

Set a browser cookie.

Syntax

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

Usage

cy.setCookie() 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.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	Notes
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
log	true	Whether to display command in Command Log
path	/	The cookie path
secure	false	Whether the cookie is a secure cookie
timeout	{% url responseTimeout configuration#Timeouts %}	Total time to wait for the cy.setCookie() command to be processed

Yields

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

• name
• value
• path
• domain
• httpOnly
• secure
• expiry

Timeout

cy.setCookie() will wait up for the duration of {% url responseTimeout configuration#Timeouts %} for the automation server to process this command.

Examples

Set Value

Set a cookie

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

Command Log

Set a cookie

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:

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

See also

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