getCookies

Improve this doc

Get all of the browser cookies.

Syntax

cy.getCookies()
cy.getCookies(options)

Usage

Correct Usage

cy.getCookies()    // Get all cookies

Arguments

options (Object)

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

Option Default Description
log true Displays the command in the Command log
timeout responseTimeout Time to wait for cy.getCookies() to resolve before timing out

Yields

cy.getCookies() yields an array of cookie objects. Each cookie object has the following properties:

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

Examples

Get Cookies

Get cookies after logging in

In this example, on first login our server sends us back a session cookie.

// assume we just logged in
cy.contains('Login').click()
cy.url().should('include', 'profile')
cy.getCookies()
  .should('have.length', 1)
  .then((cookies) => {
    expect(cookies[0]).to.have.property('name', 'session_id')
  })

Rules

Requirements

  • cy.getCookies() requires being chained off of cy.

Assertions

  • cy.getCookies() will only run assertions you've chained once, and will not retry.

Timeouts

  • cy.getCookies() should never time out.

Because cy.getCookies() is asynchronous it is technically possible for there to be a timeout while talking to the internal Cypress automation APIs. But for practical purposes it should never happen.

Command Log

cy.getCookies().should('have.length', 1).then((cookies) => {
  expect(cookies[0]).to.have.property('name', 'fakeCookie1')
  expect(cookies[0]).to.have.property('value', '123ABC')
  expect(cookies[0]).to.have.property('domain')
  expect(cookies[0]).to.have.property('httpOnly')
  expect(cookies[0]).to.have.property('path')
  expect(cookies[0]).to.have.property('secure')
})

The commands above will display in the Command Log as:

Command Log

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

Console Log

See also