tick

Improve this doc

Move time after overriding a native time function with cy.clock().

cy.clock() must be called before cy.tick() in order to override native time functions first.

Syntax

cy.tick(milliseconds)

Usage

Correct Usage

cy.tick(500)

Arguments

milliseconds (Number)

The number of milliseconds to move the clock. Any timers within the affected range of time will be called.

Yields

cy.tick() yields a clock object with the following methods:

  • clock.tick(milliseconds)

    Move the clock a number of milliseconds. Any timers within the affected range of time will be called.

  • clock.restore()

    Restore all overridden native functions. This is automatically called between tests, so should not generally be needed.

You can also access the clock object via this.clock in a .then() callback.

Examples

Milliseconds

Create a clock and move time to trigger a setTimeout

// app code loaded by index.html
window.addIntro = () => {
  setTimeout(() => {
    document.getElementById('#header').textContent = 'Hello, World'
  }, 500)
}
cy.clock()
cy.visit('/index.html')
cy.window().invoke('addIntro')
cy.tick(500)
cy.get('#header').should('have.text', 'Hello, World')

Using cy.clock() and cy.tick()

Check out our example recipe testing spying, stubbing and time

Rules

Requirements

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

  • cy.tick() requires that cy.clock() be called before it.

Assertions

  • cy.tick() is a utility command.

  • cy.tick() will not run assertions. Assertions will pass through as if this command did not exist.

Timeouts

  • cy.tick() can not time out.

Command Log

Create a clock and tick it 1 second

cy.clock()
cy.tick(1000)

The command above will display in the Command Log as:

Command Log

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

Console Log

See also