Skip to content

its.md

Latest commit

 

History

History
234 lines (161 loc) · 5.16 KB

its.md

File metadata and controls

234 lines (161 loc) · 5.16 KB
title its

Get a property's value on the previously yielded subject.

{% note info %} If you want to call a function on the previously yielded subject, use {% url .invoke() invoke %}. {% endnote %}

Syntax

.its(propertyName)
.its(propertyName, options)

Usage

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

cy.wrap({ width: '50' }).its('width') // Get the 'width' property
cy.window().its('sessionStorage')     // Get the 'sessionStorage' property

{% fa fa-exclamation-triangle red %} Incorrect Usage

cy.its('window')                // Errors, cannot be chained off 'cy'
cy.clearCookies().its('length') // Errors, 'clearCookies' does not yield Object

Arguments

{% fa fa-angle-right %} propertyName (String, Number)

Index, name of property or name of nested properties (with dot notation) to get.

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

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

Option Default Description
log true {% usage_options log %}
timeout {% url defaultCommandTimeout configuration#Timeouts %} {% usage_options timeout .its %}

Yields {% helper_icon yields %}

{% yields changes_subject .its 'yields the value of the property' %}

Examples

Objects

Get property

cy.wrap({ age: 52 }).its('age').should('eq', 52) // true

Arrays

Get index

cy.wrap(['Wai Yan', 'Yu']).its(1).should('eq', 'Yu') // true

DOM Elements

Get the length property of a DOM element

cy
  .get('ul li')       // this yields us a jquery object
  .its('length')      // calls 'length' property returning that value
  .should('be.gt', 2) // ensure the length is greater than 2
})

Requests

Get the user object of the response's body

cy
  .request(...)
  .its('body.user')
  .then(user => ...)

alternatively, use destructuring

cy
  .request(...)
  .its('body')
  .then(({user}) => ...)

Strings

Get length of title

cy.title().its('length').should('eq', 24)

Functions

Get function as property

const fn = () => {
  return 42
}

cy.wrap({ getNum: fn }).its('getNum').should('be.a', 'function')

Access function properties

You can access functions to then drill into their own properties instead of invoking them.

// Your app code
// a basic Factory constructor
const Factory = (arg) => {
  // ...
}

Factory.create = (arg) => {
  return new Factory(arg)
}

// assign it to the window
window.Factory = Factory
cy
  .window()                 // yields window object
  .its('Factory')           // yields Factory function
  .invoke('create', 'arg')  // now invoke properties on it

Use .its() to test window.fetch

{% note info %} {% url "Check out our example recipe on testing window.fetch using .its()" recipes#Stubbing-and-spying %} {% endnote %}

Nested Properties

You can drill into nested properties by using dot notation.

const user = {
  contacts: {
    work: {
      name: 'Kamil'
    }
  }
}

cy.wrap(user).its('contacts.work.name').should('eq', 'Kamil') // true

Existence

Wait for some property to exist on window

cy.window().its('globalProp').then((globalProp) => {
  // do something now that window.globalProp exists
})

Assert that a property does not exist on window

cy.window().its('evilProp').should('not.exist')

Rules

Requirements {% helper_icon requirements %}

{% requirements child .its %}

Assertions {% helper_icon assertions %}

{% assertions its .its %}

Timeouts {% helper_icon timeout %}

{% timeouts its .its %}

Command Log

Get responseBody of aliased route

cy.server()
cy.route(/comments/, 'fixture:comments.json').as('getComments')
cy.get('#fetch-comments').click()
cy.wait('@getComments').its('responseBody').should('deep.eq', [
  { id: 1, comment: 'hi' },
  { id: 2, comment: 'there' }
])

The commands above will display in the Command Log as:

{% imgTag /img/api/its/xhr-response-its-response-body-for-testing.png "Command Log for its" %}

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

{% imgTag /img/api/its/response-body-yielded-with-its-command-log.png "Console Log for its" %}

{% history %} {% url "3.8.0" changelog#3-8-0 %} | Added support for options argument {% url "3.7.0" changelog#3-7-0 %} | Added support for arguments of type Number for propertyName {% endhistory %}

See also