reload.md

title
reload

Reload the page.

Syntax

cy.reload()
cy.reload(forceReload)
cy.reload(options)
cy.reload(forceReload, options)

Usage

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

cy.reload()

Arguments

{% fa fa-angle-right %} forceReload (Boolean)

Whether to reload the current page without using the cache. true forces the reload without cache.

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

Option	Default	Description
log	true	{% usage_options log %}
timeout	{% url pageLoadTimeout configuration#Timeouts %}	{% usage_options timeout cy.reload %}

Yields {% helper_icon yields %}

{% yields sets_subject cy.reload 'yields the window object after the page finishes loading' %}

Examples

No Args

Reload the page as if the user clicked 'Refresh'

cy.visit('http://localhost:3000/admin')
cy.get('#undo-btn').click().should('not.be.visible')
cy.reload()
cy.get('#undo-btn').click().should('not.be.visible')

Force Reload

Reload the page without using the cache

cy.visit('http://localhost:3000/admin')
cy.reload(true)

Rules

Requirements {% helper_icon requirements %}

{% requirements page cy.reload %}

Assertions {% helper_icon assertions %}

{% assertions wait cy.reload %}

Timeouts {% helper_icon timeout %}

{% timeouts page cy.reload %}

Command Log

Reload the page

cy.reload()

The commands above will display in the Command Log as:

{% imgTag /img/api/reload/test-page-after-reload-button.png "Command Log reload" %}

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

{% imgTag /img/api/reload/command-log-for-reload-cypress.png "Console Log reload" %}

See also

• {% url cy.go() go %}
• {% url cy.visit() visit %}