diff --git a/docs/source/api/commands/_scrollintoview.md b/docs/source/api/commands/_scrollintoview.md index ce953c009f..85f6d77138 100644 --- a/docs/source/api/commands/_scrollintoview.md +++ b/docs/source/api/commands/_scrollintoview.md @@ -42,7 +42,7 @@ Option | Default | Notes `easing` | `swing` | Will scroll with the easing animation `log` | `true` | Whether to display command in Command Log `offset` | `{top: 0, left: 0}` | Amount to scroll after the element has been scrolled into view -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the scroll +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the scroll ## Yields @@ -50,7 +50,7 @@ Option | Default | Notes ## Timeout -`.scrollIntoView()` will continue to scroll the element into view for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.scrollIntoView()` will continue to scroll the element into view for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/_scrollto.md b/docs/source/api/commands/_scrollto.md index 65d7f9807e..46723e006c 100644 --- a/docs/source/api/commands/_scrollto.md +++ b/docs/source/api/commands/_scrollto.md @@ -54,7 +54,7 @@ Option | Default | Notes `duration` | `0` | Scrolls over the duration (in ms) `easing` | `swing` | Will scroll with the easing animation `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the scroll +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the scroll ## Yields @@ -62,7 +62,7 @@ Option | Default | Notes ## Timeout -`cy.scrollTo()` will wait until the window or element is in a 'scrollable' state for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's options. +`cy.scrollTo()` will wait until the window or element is in a 'scrollable' state for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's options. # Examples diff --git a/docs/source/api/commands/_trigger.md b/docs/source/api/commands/_trigger.md index 1e258809a8..5f4c907f67 100644 --- a/docs/source/api/commands/_trigger.md +++ b/docs/source/api/commands/_trigger.md @@ -63,7 +63,7 @@ Option | Default | Notes `cancelable` | `true` | Whether the event is cancelable `interval` | `16` | Interval which to retry triggering the event `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry triggering the event +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry triggering the event You can also include arbitrary event properties (e.g. `clientX`, `shiftKey`) and they will be attached to the event. Passing in coordinate arguments (`clientX`, `pageX`, etc) will override the position coordinates. @@ -73,7 +73,7 @@ You can also include arbitrary event properties (e.g. `clientX`, `shiftKey`) and ## Timeout -`.trigger()` will wait until the element is in an 'interactable' state for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's options. +`.trigger()` will wait until the element is in an 'interactable' state for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's options. # Examples diff --git a/docs/source/api/commands/and.md b/docs/source/api/commands/and.md index 7269a5bd32..5b8c4ae97f 100644 --- a/docs/source/api/commands/and.md +++ b/docs/source/api/commands/and.md @@ -78,7 +78,7 @@ cy ## Timeout -`.and()` will continue to retry the assertion to the duration of the previous cy commands `timeout` or the `defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.and()` will continue to retry the assertion to the duration of the previous cy commands `timeout` or the {% url `defaultCommandTimeout` configuration#Timeouts %}. ```javascript cy.get('input', {timeout: 10000}).should('have.value', '10').and('have.class', 'error') diff --git a/docs/source/api/commands/as.md b/docs/source/api/commands/as.md index 56041a8471..6709b1bace 100644 --- a/docs/source/api/commands/as.md +++ b/docs/source/api/commands/as.md @@ -46,7 +46,7 @@ The name of the alias to be referenced later within a {% url `cy.get()` get %} o ## Timeout -`.as()` will retry the chain of commands before the `.as()` command for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) +`.as()` will retry the chain of commands before the `.as()` command for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} # Examples diff --git a/docs/source/api/commands/blur.md b/docs/source/api/commands/blur.md index 174a602d60..6fe86905ad 100644 --- a/docs/source/api/commands/blur.md +++ b/docs/source/api/commands/blur.md @@ -47,7 +47,7 @@ Option | Default | Notes ## Timeout -`.blur()` will continue to look for the focusable element to blur for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.blur()` will continue to look for the focusable element to blur for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/check.md b/docs/source/api/commands/check.md index 1ecd0cb6d0..034403ac42 100644 --- a/docs/source/api/commands/check.md +++ b/docs/source/api/commands/check.md @@ -53,7 +53,7 @@ Option | Default | Notes `force` | `false` | Forces check, disables error checking prior to check `interval` | `16` | Interval which to retry a check `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the check +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the check ## Yields @@ -61,7 +61,7 @@ Option | Default | Notes ## Timeout -`.check` will retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's options. +`.check` will retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's options. # Examples diff --git a/docs/source/api/commands/children.md b/docs/source/api/commands/children.md index b73096b4ce..85b2b3f06a 100644 --- a/docs/source/api/commands/children.md +++ b/docs/source/api/commands/children.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.children()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element(s) +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element(s) ## Yields @@ -52,7 +52,7 @@ Option | Default | Notes ## Timeout -`.children()` will continue to look for the children elements for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.children()` will continue to look for the children elements for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/clear.md b/docs/source/api/commands/clear.md index 843b8728bf..a86ef32f25 100644 --- a/docs/source/api/commands/clear.md +++ b/docs/source/api/commands/clear.md @@ -47,7 +47,7 @@ Option | Default | Notes `force` | `false` | Force clear, disables error checking prior to clear `interval` | `16` | Interval which to retry clear `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the clear +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the clear ## Yields @@ -55,7 +55,7 @@ Option | Default | Notes ## Timeout -`.clear()` will continue to look for the `input` or `textarea` for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.clear()` will continue to look for the `input` or `textarea` for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/clearcookie.md b/docs/source/api/commands/clearcookie.md index db3ca528df..4786b4c1a7 100644 --- a/docs/source/api/commands/clearcookie.md +++ b/docs/source/api/commands/clearcookie.md @@ -40,7 +40,7 @@ Pass in an options object to change the default behavior of `cy.clearCookie()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the `cy.clearCookie()` command to be processed +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the `cy.clearCookie()` command to be processed ## Yields @@ -48,7 +48,7 @@ Option | Default | Notes ## Timeout -`cy.clearCookie()` will wait up for the duration of [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the automation server to process the command. +`cy.clearCookie()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process the command. # Examples diff --git a/docs/source/api/commands/clearcookies.md b/docs/source/api/commands/clearcookies.md index 721debfd27..92ebf33cfd 100644 --- a/docs/source/api/commands/clearcookies.md +++ b/docs/source/api/commands/clearcookies.md @@ -35,7 +35,7 @@ Pass in an options object to change the default behavior of `cy.clearCookies()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the `cy.clearCookies()` command to be processed +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the `cy.clearCookies()` command to be processed ## Yields @@ -43,7 +43,7 @@ Option | Default | Notes ## Timeout -`cy.clearCookies()` will wait up for the duration of [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the automation server to process this command. +`cy.clearCookies()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process this command. # Examples diff --git a/docs/source/api/commands/clearlocalstorage.md b/docs/source/api/commands/clearlocalstorage.md index 73a84ba985..c8101230ad 100644 --- a/docs/source/api/commands/clearlocalstorage.md +++ b/docs/source/api/commands/clearlocalstorage.md @@ -38,7 +38,7 @@ Specify keys to be cleared in local storage. ## Timeout -`cy.clearLocalStorage()` will wait up for the duration of [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) to process this command. +`cy.clearLocalStorage()` will wait up for the duration of {% url `defaultCommandTimeout` configuration#Timeouts %} to process this command. # Examples diff --git a/docs/source/api/commands/click.md b/docs/source/api/commands/click.md index c29e1d853c..21fb0851f9 100644 --- a/docs/source/api/commands/click.md +++ b/docs/source/api/commands/click.md @@ -61,7 +61,7 @@ Option | Default | Notes `interval` | `16` | Interval which to retry a click `log` | `true` | Whether to display command in Command Log `multiple` | `false` | Enable serially clicking multiple elements -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the click +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the click ## Yields @@ -69,7 +69,7 @@ Option | Default | Notes ## Timeout -`.click()` will wait until the element is in a 'clickable' state for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's options. +`.click()` will wait until the element is in a 'clickable' state for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's options. # Examples diff --git a/docs/source/api/commands/clock.md b/docs/source/api/commands/clock.md index 44edb9f86b..6615b92629 100644 --- a/docs/source/api/commands/clock.md +++ b/docs/source/api/commands/clock.md @@ -204,7 +204,7 @@ When clicking on the `clock` command within the command log, the console outputs # See also -- [Guide: Stubs, Spies and Clocks ](https://on.cypress.io/guides/stubs-spies-clocks) +- {% url 'Guide: Stubs, Spies and Clocks' stubs-spies-clocks %} - {% url `cy.spy()` spy %} - {% url `cy.stub()` stub %} - [Recipe: Controlling Behavior with Spies, Stubs, and Clocks](https://github.com/cypress-io/cypress-example-recipes#controlling-behavior-with-spies-stubs-and-clocks) diff --git a/docs/source/api/commands/closest.md b/docs/source/api/commands/closest.md index e95826f67e..5bc8b4ac6d 100644 --- a/docs/source/api/commands/closest.md +++ b/docs/source/api/commands/closest.md @@ -42,7 +42,7 @@ Pass in an options object to change the default behavior of `.closest()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -50,7 +50,7 @@ Option | Default | Notes ## Timeout -`.closest()` will continue to look for the closest element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.closest()` will continue to look for the closest element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/contains.md b/docs/source/api/commands/contains.md index 3e23b0d63a..e90d36bbac 100644 --- a/docs/source/api/commands/contains.md +++ b/docs/source/api/commands/contains.md @@ -48,7 +48,7 @@ Pass in an options object to change the default behavior of `cy.contains()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry finding an element containing the content +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry finding an element containing the content ## Yields @@ -56,7 +56,7 @@ Option | Default | Notes ## Timeout -`cy.contains()` will try to find the content within the DOM for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.contains()` will try to find the content within the DOM for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/dblclick.md b/docs/source/api/commands/dblclick.md index 5165489b9f..e5218657da 100644 --- a/docs/source/api/commands/dblclick.md +++ b/docs/source/api/commands/dblclick.md @@ -47,7 +47,7 @@ Option | Default | Notes ## Timeout -`.dblclick()` will wait for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.dblclick()` will wait for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/document.md b/docs/source/api/commands/document.md index c93ccf27e8..a0385c25b3 100644 --- a/docs/source/api/commands/document.md +++ b/docs/source/api/commands/document.md @@ -38,7 +38,7 @@ Option | Default | Notes ## Timeout -`cy.document()` will retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.document()` will retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/eq.md b/docs/source/api/commands/eq.md index 739abd38e6..ce9aa76fbd 100644 --- a/docs/source/api/commands/eq.md +++ b/docs/source/api/commands/eq.md @@ -49,7 +49,7 @@ Pass in an options object to change the default behavior of `.eq()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -57,7 +57,7 @@ Option | Default | Notes ## Timeout -`.eq()` will continue to look for the element at the specified index for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.eq()` will continue to look for the element at the specified index for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/exec.md b/docs/source/api/commands/exec.md index c1cd9e55b6..4776f3a274 100644 --- a/docs/source/api/commands/exec.md +++ b/docs/source/api/commands/exec.md @@ -37,7 +37,7 @@ Option | Default | Notes `env` | `{}` | Object of environment variables to set before the command executes (e.g. `{USERNAME: 'johndoe'}`). Will be merged with existing system environment variables `failOnNonZeroExit` | `true` | whether to fail if the command exits with a non-zero code `log` | `true` | Whether to display command in Command Log -`timeout` | [`execTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to allow the command to execute +`timeout` | {% url `execTimeout` configuration#Timeouts %} | Total time to allow the command to execute ## Yields @@ -49,7 +49,7 @@ Option | Default | Notes ## Timeout -`cy.exec()` will allow the command to execute for the duration of the [`execTimeout`](https://on.cypress.io/guides/configuration#timeouts) or the `timeout` passed into the command's options. +`cy.exec()` will allow the command to execute for the duration of the {% url `execTimeout` configuration#Timeouts %} or the `timeout` passed into the command's options. # Examples diff --git a/docs/source/api/commands/filter.md b/docs/source/api/commands/filter.md index 451fb97b92..c24883a2fb 100644 --- a/docs/source/api/commands/filter.md +++ b/docs/source/api/commands/filter.md @@ -46,7 +46,7 @@ Pass in an options object to change the default behavior of `.filter()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -54,7 +54,7 @@ Option | Default | Notes ## Timeout -`.filter()` will continue to look for the filtered element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.filter()` will continue to look for the filtered element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/find.md b/docs/source/api/commands/find.md index af878f25f8..d91341411c 100644 --- a/docs/source/api/commands/find.md +++ b/docs/source/api/commands/find.md @@ -42,7 +42,7 @@ Pass in an options object to change the default behavior of `.find()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element(s) +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element(s) ## Yields @@ -50,7 +50,7 @@ Option | Default | Notes ## Timeout -`.find()` will continue to look for the filtered element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.find()` will continue to look for the filtered element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/first.md b/docs/source/api/commands/first.md index c04d6781df..a54565ba98 100644 --- a/docs/source/api/commands/first.md +++ b/docs/source/api/commands/first.md @@ -38,7 +38,7 @@ Pass in an options object to change the default behavior of `.first()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -46,7 +46,7 @@ Option | Default | Notes ## Timeout -`.first()` will continue to look for the first element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.first()` will continue to look for the first element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/fixture.md b/docs/source/api/commands/fixture.md index f2f6d507f5..7300bb4714 100644 --- a/docs/source/api/commands/fixture.md +++ b/docs/source/api/commands/fixture.md @@ -35,7 +35,7 @@ cy.fixture('logo.png').then(function(logo){ **{% fa fa-angle-right %} filePath** ***(String)*** -A path to a file within the [`fixturesFolder`](https://on.cypress.io/guides/configuration#folders) , which defaults to `cypress/fixtures`. +A path to a file within the {% url `fixturesFolder` configuration#Folders %} , which defaults to `cypress/fixtures`. You can nest fixtures within folders and reference them by defining the path from the fixturesFolder: @@ -65,7 +65,7 @@ Pass in an options object to change the default behavior of `cy.fixture()`. Option | Default | Notes --- | --- | --- -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the command to be processed +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the command to be processed ## Yields @@ -73,7 +73,7 @@ Option | Default | Notes ## Timeout -`cy.fixture` will wait up for the duration of [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the server to process the command. +`cy.fixture` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the server to process the command. # Examples @@ -87,7 +87,7 @@ cy.fixture('users.json').as('usersData') **Omit the fixture file's extension** -When no extension is passed to `cy.fixture()`, Cypress will search for files with the specified name within the [`fixturesFolder`](https://on.cypress.io/guides/configuration#folders) (which defaults to `cypress/fixtures`) and resolve the first one. +When no extension is passed to `cy.fixture()`, Cypress will search for files with the specified name within the {% url `fixturesFolder` configuration#Folders %} (which defaults to `cypress/fixtures`) and resolve the first one. ```javascript cy.fixture('admin').as('adminJSON') diff --git a/docs/source/api/commands/focus.md b/docs/source/api/commands/focus.md index 5fba167382..5cc81e9e94 100644 --- a/docs/source/api/commands/focus.md +++ b/docs/source/api/commands/focus.md @@ -45,7 +45,7 @@ Option | Default | Notes ## Timeout -`.focus()` will continue to try to focus the element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.focus()` will continue to try to focus the element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/focused.md b/docs/source/api/commands/focused.md index cd365439a8..79c2f8c0f6 100644 --- a/docs/source/api/commands/focused.md +++ b/docs/source/api/commands/focused.md @@ -38,7 +38,7 @@ Option | Default | Notes ## Timeout -`cy.focused()` will continue to look for the focused element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.focused()` will continue to look for the focused element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/get.md b/docs/source/api/commands/get.md index 53f142c244..0f786f7d44 100644 --- a/docs/source/api/commands/get.md +++ b/docs/source/api/commands/get.md @@ -47,7 +47,7 @@ Pass in an options object to change the default behavior of `cy.get()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -55,7 +55,7 @@ Option | Default | Notes ## Timeout -`cy.get()` will continue to look for the elements for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.get()` will continue to look for the elements for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/getcookie.md b/docs/source/api/commands/getcookie.md index 05ecee0b6b..356fe55108 100644 --- a/docs/source/api/commands/getcookie.md +++ b/docs/source/api/commands/getcookie.md @@ -35,7 +35,7 @@ Pass in an options object to change the default behavior of `cy.getCookie()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the `cy.getCookie()` command to be processed +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the `cy.getCookie()` command to be processed ## Yields @@ -51,7 +51,7 @@ Option | Default | Notes ## Timeout -`cy.getCookie()` will continue to look for the cookie for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.getCookie()` will continue to look for the cookie for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/getcookies.md b/docs/source/api/commands/getcookies.md index cd6ddb4e59..627b63f83d 100644 --- a/docs/source/api/commands/getcookies.md +++ b/docs/source/api/commands/getcookies.md @@ -31,7 +31,7 @@ Pass in an options object to change the default behavior of `cy.getCookies()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the `cy.getCookies()` command to be processed +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the `cy.getCookies()` command to be processed ## Yields @@ -47,7 +47,7 @@ Option | Default | Notes ## Timeout -`cy.getCookies()` will continue to look for cookies for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.getCookies()` will continue to look for cookies for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/go.md b/docs/source/api/commands/go.md index 67bb7bbbcf..8f5f882df9 100644 --- a/docs/source/api/commands/go.md +++ b/docs/source/api/commands/go.md @@ -38,7 +38,7 @@ Pass in an options object to change the default behavior of `cy.go()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [pageLoadTimeout](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the navigation +`timeout` | {% url `pageLoadTimeout` configuration#Timeouts %} | Total time to retry the navigation ## Yields @@ -46,7 +46,7 @@ Option | Default | Notes ## Timeout -`cy.go()` will retry for the duration of the [pageLoadTimeout](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's options. +`cy.go()` will retry for the duration of the {% url `pageLoadTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's options. # Examples diff --git a/docs/source/api/commands/last.md b/docs/source/api/commands/last.md index 9492ea1d43..5403464605 100644 --- a/docs/source/api/commands/last.md +++ b/docs/source/api/commands/last.md @@ -38,7 +38,7 @@ Pass in an options object to change the default behavior of `.last()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -46,7 +46,7 @@ Option | Default | Notes ## Timeout -`.last()` will continue to look for the last element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.last()` will continue to look for the last element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/next.md b/docs/source/api/commands/next.md index 8f072fd076..a5b1f90c4a 100644 --- a/docs/source/api/commands/next.md +++ b/docs/source/api/commands/next.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.next()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -52,7 +52,7 @@ Option | Default | Notes ## Timeout -`.next()` will continue to look for the next element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.next()` will continue to look for the next element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/nextall.md b/docs/source/api/commands/nextall.md index 244f4d169b..9ec3df3029 100644 --- a/docs/source/api/commands/nextall.md +++ b/docs/source/api/commands/nextall.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.nextAll()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -52,7 +52,7 @@ Option | Default | Notes ## Timeout -`.nextAll()` will continue to look for all next element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.nextAll()` will continue to look for all next element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/nextuntil.md b/docs/source/api/commands/nextuntil.md index 04a5e9a186..71ff394cd2 100644 --- a/docs/source/api/commands/nextuntil.md +++ b/docs/source/api/commands/nextuntil.md @@ -55,7 +55,7 @@ Pass in an options object to change the default behavior of `.nextUntil()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element(s) +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element(s) ## Yields @@ -63,7 +63,7 @@ Option | Default | Notes ## Timeout -`.nextUntil()` will continue to look for the next element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.nextUntil()` will continue to look for the next element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/not.md b/docs/source/api/commands/not.md index 3605d9f905..74855b41f3 100644 --- a/docs/source/api/commands/not.md +++ b/docs/source/api/commands/not.md @@ -46,7 +46,7 @@ Pass in an options object to change the default behavior of `.not()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -54,7 +54,7 @@ Option | Default | Notes ## Timeout -`.not()` will continue to look for the element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.not()` will continue to look for the element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/parent.md b/docs/source/api/commands/parent.md index f29f5cb1a9..aed2a6e671 100644 --- a/docs/source/api/commands/parent.md +++ b/docs/source/api/commands/parent.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.parent()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -52,7 +52,7 @@ Option | Default | Notes ## Timeout -`.parent()` will continue to look for the parent element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.parent()` will continue to look for the parent element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/parents.md b/docs/source/api/commands/parents.md index b76ca596b0..0f876b0a18 100644 --- a/docs/source/api/commands/parents.md +++ b/docs/source/api/commands/parents.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.parents()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the elements +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the elements ## Yields @@ -53,7 +53,7 @@ Option | Default | Notes ## Timeout -`.parents()` will continue to look for the next element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.parents()` will continue to look for the next element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/parentsuntil.md b/docs/source/api/commands/parentsuntil.md index 6b572fe821..c8ef5c81ea 100644 --- a/docs/source/api/commands/parentsuntil.md +++ b/docs/source/api/commands/parentsuntil.md @@ -54,7 +54,7 @@ Pass in an options object to change the default behavior of `.parentsUntil()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element(s) +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element(s) ## Yields @@ -62,7 +62,7 @@ Option | Default | Notes ## Timeout -`.parentsUntil()` will continue to look for the parent element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.parentsUntil()` will continue to look for the parent element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/prev.md b/docs/source/api/commands/prev.md index 6521f1052e..4b4ef9ec7c 100644 --- a/docs/source/api/commands/prev.md +++ b/docs/source/api/commands/prev.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.prev()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -52,7 +52,7 @@ Option | Default | Notes ## Timeout -`.prev()` will continue to look for the previous element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.prev()` will continue to look for the previous element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/prevall.md b/docs/source/api/commands/prevall.md index c3935e304a..f6b6d8f4f3 100644 --- a/docs/source/api/commands/prevall.md +++ b/docs/source/api/commands/prevall.md @@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.prevAll()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -52,7 +52,7 @@ Option | Default | Notes ## Timeout -`.prevAll()` will continue to look for the previous elements for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.prevAll()` will continue to look for the previous elements for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/prevuntil.md b/docs/source/api/commands/prevuntil.md index 1b1f70a89e..8a4be4a414 100644 --- a/docs/source/api/commands/prevuntil.md +++ b/docs/source/api/commands/prevuntil.md @@ -54,7 +54,7 @@ Pass in an options object to change the default behavior of `.prevUntil()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element(s) +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element(s) ## Yields @@ -62,7 +62,7 @@ Option | Default | Notes ## Timeout -`.prevUntil()` will continue to look for the previous element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.prevUntil()` will continue to look for the previous element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/readfile.md b/docs/source/api/commands/readfile.md index a377ab51e5..e8f48d935c 100644 --- a/docs/source/api/commands/readfile.md +++ b/docs/source/api/commands/readfile.md @@ -52,7 +52,7 @@ Pass in an options object to change the default behavior of `cy.readFile()`. Option | Default | Notes --- | --- | --- -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the command to be processed +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to wait for the command to be processed ## Yields @@ -60,7 +60,7 @@ Option | Default | Notes ## Timeout -`cy.readFile()` will wait up for the duration of [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the server to process the command. +`cy.readFile()` will wait up for the duration of {% url `defaultCommandTimeout` configuration#Timeouts %} for the server to process the command. # Examples diff --git a/docs/source/api/commands/reload.md b/docs/source/api/commands/reload.md index 0956eeac04..552afacf98 100644 --- a/docs/source/api/commands/reload.md +++ b/docs/source/api/commands/reload.md @@ -35,7 +35,7 @@ Whether to reload the current page without using the cache. `true` forces the re Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [pageLoadTimeout](https://on.cypress.io/guides/configuration#timeouts) | Total time to reload the page +`timeout` | {% url `pageLoadTimeout` configuration#Timeouts %} | Total time to reload the page ## Yields @@ -43,7 +43,7 @@ Option | Default | Notes ## Timeout -`cy.reload()` will wait for the load event of the newly loaded page for the duration of the [pageLoadTimeout](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's options. +`cy.reload()` will wait for the load event of the newly loaded page for the duration of the {% url `pageLoadTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's options. # Examples diff --git a/docs/source/api/commands/request.md b/docs/source/api/commands/request.md index 0228dd5fe1..395fe68e46 100644 --- a/docs/source/api/commands/request.md +++ b/docs/source/api/commands/request.md @@ -80,10 +80,10 @@ Option | Default | Notes `log` | `true` | Whether to log the request in the Command Log `method` | `GET` | The HTTP method to use in the request `qs` | `null` | Query parameters to append to the `url` of the request -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for a response (in ms) +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for a response (in ms) `url` | `null` | The URL to make the request to -You can also set options for `cy.request`'s `baseUrl` and `responseTimeout` globally in [configuration](https://on.cypress.io/guides/configuration). +You can also set options for `cy.request`'s `baseUrl` and `responseTimeout` globally in {% url 'configuration' configuration %}. ## Yields @@ -96,7 +96,7 @@ You can also set options for `cy.request`'s `baseUrl` and `responseTimeout` glob ## Timeout -`cy.request()` will wait for the response for the duration of the [responseTimeout](https://on.cypress.io/guides/configuration#timeouts) or the `timeout` passed in the options object of the command. +`cy.request()` will wait for the response for the duration of the {% url `responseTimeout` configuration#Timeouts %} or the `timeout` passed in the options object of the command. # Examples diff --git a/docs/source/api/commands/root.md b/docs/source/api/commands/root.md index fba011bdf1..8322c312fa 100644 --- a/docs/source/api/commands/root.md +++ b/docs/source/api/commands/root.md @@ -44,7 +44,7 @@ The root element yielded is `document` by default. However, when calling `.root( ## Timeout -`.root()` will continue to look for the root element for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.root()` will continue to look for the root element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/route.md b/docs/source/api/commands/route.md index a692cf235b..dcd6b05de5 100644 --- a/docs/source/api/commands/route.md +++ b/docs/source/api/commands/route.md @@ -65,7 +65,7 @@ Option | Default | Notes `status` | `200` | Response status code when stubbing routes `url` | `null` | String or RegExp url to match against request urls -You can also set options for all {% url `cy.wait()` wait %}'s `requestTimeout` and `responseTimeout` globally in [configuration](https://on.cypress.io/guides/configuration) to control how long to wait for the request and response of a supplied route. +You can also set options for all {% url `cy.wait()` wait %}'s `requestTimeout` and `responseTimeout` globally in {% url 'configuration' configuration %} to control how long to wait for the request and response of a supplied route. ## Yields diff --git a/docs/source/api/commands/screenshot.md b/docs/source/api/commands/screenshot.md index 3f4b946d37..4cc3c133ed 100644 --- a/docs/source/api/commands/screenshot.md +++ b/docs/source/api/commands/screenshot.md @@ -37,7 +37,7 @@ Pass in an options object to change the default behavior of `cy.screenshot()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the automation server to process the command. +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the automation server to process the command. ## Yields @@ -45,13 +45,13 @@ Option | Default | Notes ## Timeout -`cy.screenshot()` will wait up for the duration of [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the automation server to process this command. +`cy.screenshot()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process this command. # Examples The screenshot will be stored in the `cypress/screenshots` folder by default. -You can change the directory where screenshots are saved in your [configuration](https://on.cypress.io/guides/configuration#folders). +You can change the directory where screenshots are saved in your {% url 'configuration' configuration#Folders %}. ## Screenshot @@ -79,7 +79,7 @@ cy.screenshot('clickingOnNav') **Automatic screenshots on test failure** -When running headlessly or in [Continuous Integration](https://on.cypress.io/guides/continuous-integration), Cypress automatically takes a screenshot when a test fails. You can optionally turn this off by setting `screenshotOnHeadlessFailure` to `false` in your [configuration](https://on.cypress.io/guides/configuration). +When running headlessly or in {% url 'Continuous Integration' continuous-integration %}, Cypress automatically takes a screenshot when a test fails. You can optionally turn this off by setting `screenshotOnHeadlessFailure` to `false` in your {% url 'configuration' configuration %}. **Screenshots in CI** diff --git a/docs/source/api/commands/select.md b/docs/source/api/commands/select.md index c3224e7197..a8624b4c3d 100644 --- a/docs/source/api/commands/select.md +++ b/docs/source/api/commands/select.md @@ -50,7 +50,7 @@ Option | Default | Notes `force` | `false` | Forces select, disables error checking prior to select `interval` | `50` | Interval which to retry a select `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the select +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the select ## Yields @@ -59,7 +59,7 @@ Option | Default | Notes ## Timeout -`.select()` will continue to select the options for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.select()` will continue to select the options for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/setcookie.md b/docs/source/api/commands/setcookie.md index 4659a5d25c..8794d17d97 100644 --- a/docs/source/api/commands/setcookie.md +++ b/docs/source/api/commands/setcookie.md @@ -44,7 +44,7 @@ Option | Default | Notes `log` | `true` | Whether to display command in Command Log `path` | `/` | The cookie path `secure` | `false` | Whether the cookie is a secure cookie -`timeout` | [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the `cy.setCookie()` command to be processed +`timeout` | {% url `responseTimeout` configuration#Timeouts %} | Total time to wait for the `cy.setCookie()` command to be processed ## Yields @@ -60,7 +60,7 @@ Option | Default | Notes ## Timeout -`cy.setCookie()` will wait up for the duration of [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the automation server to process this command. +`cy.setCookie()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process this command. # Examples diff --git a/docs/source/api/commands/should.md b/docs/source/api/commands/should.md index ce8e377316..fef022833c 100644 --- a/docs/source/api/commands/should.md +++ b/docs/source/api/commands/should.md @@ -79,7 +79,7 @@ cy ## Timeout -`.should()` will continue to retry the assertion to the duration of the previous cy commands `timeout` or the `defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.should()` will continue to retry the assertion to the duration of the previous cy commands `timeout` or the {% url `defaultCommandTimeout` configuration#Timeouts %}. ```javascript cy.get('input', {timeout: 10000}).should('have.value', '10') diff --git a/docs/source/api/commands/siblings.md b/docs/source/api/commands/siblings.md index c62e61173f..326824b3d0 100644 --- a/docs/source/api/commands/siblings.md +++ b/docs/source/api/commands/siblings.md @@ -45,7 +45,7 @@ Pass in an options object to change the default behavior of `.siblings()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry getting the element ## Yields @@ -53,7 +53,7 @@ Option | Default | Notes ## Timeout -`.siblings()` will continue to look for the sibling element(s) for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.siblings()` will continue to look for the sibling element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/spy.md b/docs/source/api/commands/spy.md index 30a7ff1dda..dba9ba6aa7 100644 --- a/docs/source/api/commands/spy.md +++ b/docs/source/api/commands/spy.md @@ -116,6 +116,6 @@ When clicking on the `spy-1` event within the command log, the console outputs t - {% url `.as()` as %} - {% url `cy.clock()` clock %} -- [Guide: Stubs, Spies and Clocks ](https://on.cypress.io/guides/stubs-spies-clocks) +- {% url 'Guide: Stubs, Spies and Clocks' stubs-spies-clocks %} - [Recipe: Controlling Behavior with Spies, Stubs, and Clocks](https://github.com/cypress-io/cypress-example-recipes#controlling-behavior-with-spies-stubs-and-clocks) - {% url `cy.stub()` stub %} diff --git a/docs/source/api/commands/stub.md b/docs/source/api/commands/stub.md index 2f1d888903..9d2c2738f3 100644 --- a/docs/source/api/commands/stub.md +++ b/docs/source/api/commands/stub.md @@ -162,7 +162,7 @@ When clicking on the `(stub-1)` event within the command log, the console output - {% url `.as()` as %} - {% url `cy.clock()` clock %} -- [Guide: Stubs, Spies and Clocks ](https://on.cypress.io/guides/stubs-spies-clocks) +- {% url 'Guide: Stubs, Spies and Clocks' stubs-spies-clocks %} - [Recipe: Controlling Behavior with Spies, Stubs, and Clocks](https://github.com/cypress-io/cypress-example-recipes#controlling-behavior-with-spies-stubs-and-clocks) - [Recipe: Unit Test - Stubbing Dependencies](https://github.com/cypress-io/cypress-example-recipes#unit-test---stubbing-dependencies) - {% url `cy.spy()` spy %} diff --git a/docs/source/api/commands/submit.md b/docs/source/api/commands/submit.md index 1d1042e78c..3719dce15e 100644 --- a/docs/source/api/commands/submit.md +++ b/docs/source/api/commands/submit.md @@ -41,7 +41,7 @@ Pass in an options object to change the default behavior of `.submit()`. ## Timeout -`.submit()` will continue to try to submit the form for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.submit()` will continue to try to submit the form for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Example diff --git a/docs/source/api/commands/then.md b/docs/source/api/commands/then.md index b6723bb115..5b1aa8d08a 100644 --- a/docs/source/api/commands/then.md +++ b/docs/source/api/commands/then.md @@ -35,7 +35,7 @@ Pass in an options object to change the default behavior of `.then()`. Option | Default | Notes --- | --- | --- -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to yield the then +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to yield the then ## Yields @@ -47,7 +47,7 @@ Just like Promises, you can return any compatible "thenable" (anything that has ## Timeout -`.then()` will retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's [options](#options). +`.then()` will retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's [options](#options). # Examples diff --git a/docs/source/api/commands/tick.md b/docs/source/api/commands/tick.md index 1260122a5e..45b0095345 100644 --- a/docs/source/api/commands/tick.md +++ b/docs/source/api/commands/tick.md @@ -95,7 +95,7 @@ When clicking on the `tick` command within the command log, the console outputs # See also - {% url `cy.clock()` clock %} -- [Guide: Stubs, Spies and Clocks ](https://on.cypress.io/guides/stubs-spies-clocks) +- {% url 'Guide: Stubs, Spies and Clocks' stubs-spies-clocks %} - [Recipe: Controlling Behavior with Spies, Stubs, and Clocks](https://github.com/cypress-io/cypress-example-recipes#controlling-behavior-with-spies-stubs-and-clocks) - {% url `cy.spy()` spy %} - {% url `cy.stub()` stub %} diff --git a/docs/source/api/commands/title.md b/docs/source/api/commands/title.md index e0d082a1a2..cc2a820b06 100644 --- a/docs/source/api/commands/title.md +++ b/docs/source/api/commands/title.md @@ -39,7 +39,7 @@ Option | Default | Notes ## Timeout -`cy.title()` will continue to retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) +`cy.title()` will continue to retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %} # Examples diff --git a/docs/source/api/commands/type.md b/docs/source/api/commands/type.md index f18cd7ac07..90ef95e6bd 100644 --- a/docs/source/api/commands/type.md +++ b/docs/source/api/commands/type.md @@ -70,7 +70,7 @@ Option | Default | Notes `interval` | `16` | Interval to retry type `log` | `true` | Whether to display command in Command Log `release` | `true` | Keep a modifier activated between commands -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the type +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the type ## Yields @@ -78,7 +78,7 @@ Option | Default | Notes ## Timeout -`.type()` will continue to retry typing for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`.type()` will continue to retry typing for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/uncheck.md b/docs/source/api/commands/uncheck.md index f89489a980..fca2ee0fd7 100644 --- a/docs/source/api/commands/uncheck.md +++ b/docs/source/api/commands/uncheck.md @@ -52,7 +52,7 @@ Option | Default | Notes `force` | `false` | Forces check, disables error checking prior to check `interval` | `16` | Interval which to retry a check `log` | `true` | Whether to display command in Command Log -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry the check +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to retry the check # Examples diff --git a/docs/source/api/commands/viewport.md b/docs/source/api/commands/viewport.md index 1940d63af9..ae1db64bd4 100644 --- a/docs/source/api/commands/viewport.md +++ b/docs/source/api/commands/viewport.md @@ -6,7 +6,7 @@ comments: true Control the size and orientation of the screen for your application. {% note info %} -You can set the viewport's width and height globally by defining `viewportWidth` and `viewportHeight` in the [configuration](https://on.cypress.io/guides/configuration). +You can set the viewport's width and height globally by defining `viewportWidth` and `viewportHeight` in the {% url 'configuration' configuration %}. {% endnote %} # Syntax @@ -151,7 +151,7 @@ When hovering over each command, Cypress will automatically display the snapshot By default, until you issue a `cy.viewport()` command, Cypress sets the width to `1000px` and the height to `660px` by default. -You can [change these default dimensions](https://on.cypress.io/guides/configuration) by adding the following to your `cypress.json`: +You can {% url 'change these default dimensions' configuration#Viewport %} by adding the following to your `cypress.json`: ```json { @@ -172,4 +172,4 @@ The upsides to this are that tests should consistently pass or fail regardless o # See also -- [Configuration](https://on.cypress.io/guides/configuration) +- {% url 'configuration' configuration %} diff --git a/docs/source/api/commands/visit.md b/docs/source/api/commands/visit.md index b8e06c80c2..a8f0078719 100644 --- a/docs/source/api/commands/visit.md +++ b/docs/source/api/commands/visit.md @@ -37,9 +37,9 @@ Option | Default | Notes `log` | `true` | Whether to display command in Command Log `onBeforeLoad` | `function` | Called before your page has loaded all of its resources. `onLoad` | `function` | Called once your page has fired its load event. -`timeout` | [pageLoadTimeout](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait until `cy.visit()` resolves +`timeout` | {% url `pageLoadTimeout` configuration#Timeouts %} | Total time to wait until `cy.visit()` resolves -You can also set all `cy.visit()` commands' `pageLoadTimeout` and `baseUrl` globally in [configuration](https://on.cypress.io/guides/configuration). +You can also set all `cy.visit()` commands' `pageLoadTimeout` and `baseUrl` globally in {% url 'configuration' configuration %}. ## Yields @@ -47,7 +47,7 @@ You can also set all `cy.visit()` commands' `pageLoadTimeout` and `baseUrl` glob ## Timeout -`cy.visit()` will retry for the duration of the [pageLoadTimeout](https://on.cypress.io/guides/configuration#timeouts) or the duration of the `timeout` specified in the command's [options](#options). +`cy.visit()` will retry for the duration of the {% url `pageLoadTimeout` configuration#Timeouts %} or the duration of the `timeout` specified in the command's [options](#options). # Examples @@ -83,7 +83,7 @@ cy.visit('app/index.html') **Visit is automatically prefixed with `baseUrl`.** -Configure `baseUrl` in the `cypress.json` file to prevent repeating yourself in every single `cy.visit()` command. Read more about [`configuration`](https://on.cypress.io/guides/configuration). +Configure `baseUrl` in the `cypress.json` file to prevent repeating yourself in every single `cy.visit()` command. Read more about {% url 'configuration' configuration %}. ```json { diff --git a/docs/source/api/commands/wait.md b/docs/source/api/commands/wait.md index 1de505373f..8ffe18e25c 100644 --- a/docs/source/api/commands/wait.md +++ b/docs/source/api/commands/wait.md @@ -52,9 +52,9 @@ Pass in an options object to change the default behavior of `cy.wait()`. Option | Default | Notes --- | --- | --- `log` | `true` | Whether to display command in Command Log -`timeout` | [requestTimeout](https://on.cypress.io/guides/configuration#timeouts), [responseTimeout](https://on.cypress.io/guides/configuration#timeouts) | Override the default requestTimeout and responseTimeout (in ms) +`timeout` | {% url `requestTimeout` configuration#Timeouts %}, {% url `responseTimeout` configuration#Timeouts %} | Override the default requestTimeout and responseTimeout (in ms) -You can also change the `requestTimeout` and `responseTimeout` globally for all `cy.wait()` commands in the [configuration](https://on.cypress.io/guides/configuration). +You can also change the `requestTimeout` and `responseTimeout` globally for all `cy.wait()` commands in the {% url 'configuration' configuration %}. ## Yields @@ -64,7 +64,7 @@ When given an `alias` argument, `cy.wait()` yields the XHR object of the aliased ## Timeout -`cy.wait()` will wait for the request the duration of the [requestTimeout](https://on.cypress.io/guides/configuration#timeouts) and wait for the response for the duration of the [responseTimeout](https://on.cypress.io/guides/configuration#timeouts) or it will wait for the duration of both the request and response for the `timeout` specified in the command's [options](#options). +`cy.wait()` will wait for the request the duration of the {% url `requestTimeout` configuration#Timeouts %} and wait for the response for the duration of the {% url `responseTimeout` configuration#Timeouts %} or it will wait for the duration of both the request and response for the `timeout` specified in the command's [options](#options). # Examples @@ -201,13 +201,13 @@ cy.wait(['@getUsers', '@getActivities', 'getComments']) When used with an alias, `cy.wait()` goes through two separate "waiting" periods. -The first period waits for a matching request to leave the browser. This duration is configured by [`requestTimeout`](https://on.cypress.io/guides/configuration#timeouts) - which has a default of `5000` ms. +The first period waits for a matching request to leave the browser. This duration is configured by {% url `requestTimeout` configuration#Timeouts %} - which has a default of `5000` ms. This means that when you begin waiting for an aliased XHR, Cypress will wait up to 5 seconds for a matching XHR to be created. If no matching XHR is found, you will get an error message that looks like this: ![screen shot 2015-12-21 at 5 00 09 pm](https://cloud.githubusercontent.com/assets/1268976/11942578/8e7cba50-a805-11e5-805c-614f8640fbcc.png) -Once Cypress detects that a matching XHR has begun its request, it then switches over to the 2nd waiting period. This duration is configured by [`responseTimeout`](https://on.cypress.io/guides/configuration#timeouts) - which has a default of `20000` ms. +Once Cypress detects that a matching XHR has begun its request, it then switches over to the 2nd waiting period. This duration is configured by {% url `responseTimeout` configuration#Timeouts %} - which has a default of `20000` ms. This means Cypress will now wait up to 20 seconds for the external server to respond to this XHR. If no response is detected, you will get an error message that looks like this: diff --git a/docs/source/api/commands/window.md b/docs/source/api/commands/window.md index 71f06956ba..c00908e989 100644 --- a/docs/source/api/commands/window.md +++ b/docs/source/api/commands/window.md @@ -38,7 +38,7 @@ Option | Default | Notes ## Timeout -`cy.window()` will retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts). +`cy.window()` will retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}. # Examples diff --git a/docs/source/api/commands/writefile.md b/docs/source/api/commands/writefile.md index bba5502ca6..6fade35d06 100644 --- a/docs/source/api/commands/writefile.md +++ b/docs/source/api/commands/writefile.md @@ -56,7 +56,7 @@ Pass in an options object to change the default behavior of `cy.writeFile()`. Option | Default | Notes --- | --- | --- -`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to wait for the command to be processed. +`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | Total time to wait for the command to be processed. ## Yields @@ -64,7 +64,7 @@ Option | Default | Notes ## Timeout -`cy.writeFile()` will wait up for the duration of [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) for the server to write to the file. +`cy.writeFile()` will wait up for the duration of {% url `defaultCommandTimeout` configuration#Timeouts %} for the server to write to the file. # Examples diff --git a/docs/source/api/cypress-api/config.md b/docs/source/api/cypress-api/config.md index ac1c509734..5ac97bed02 100644 --- a/docs/source/api/cypress-api/config.md +++ b/docs/source/api/cypress-api/config.md @@ -6,7 +6,7 @@ comments: true `get` and `set` configuration options *in your tests*. {% note info New to Cypress? %} -[Read about configuration first.](https://on.cypress.io/guides/configuration) +{% url 'Read about configuration first.' configuration %} {% endnote %} # Syntax @@ -143,4 +143,4 @@ Methods on `cy` are local and specific to a single test. Side effects from `cy` # See also -- [Configuration](https://on.cypress.io/guides/configuration) +- {% url 'configuration' configuration %} diff --git a/docs/source/guides/appendices/_changelog_older.md b/docs/source/guides/appendices/_changelog_older.md index 73a3398ad6..bf14cc97e5 100644 --- a/docs/source/guides/appendices/_changelog_older.md +++ b/docs/source/guides/appendices/_changelog_older.md @@ -76,7 +76,7 @@ **Features:** -- Added `waitForAnimations` and `animationDistanceThreshold` [configuration options](https://on.cypress.io/guides/configuration). +- Added `waitForAnimations` and `animationDistanceThreshold` {% url 'configuration options' configuration#Animations %}. - Cypress now automatically detects and waits for an element which is animating to stop animating. The threshold that Cypress considers *animating* is set to a distance of `5px` per `60fps`. In other words, if your element is moving too fast for a user to interact with, then Cypress considers the element animating and will wait until it finishes before attempting to interact with it. When we say 'interact' we mean apply command actions like {% url `.click()` click %}, {% url `.select()` select %}, {% url `.type()` type %}, {% url `.check()` check %}, etc. Waiting for animations prevents a series of edge cases and weird bugs where Cypress was interacting with elements **too** quickly which might cause undesired side effects in your application which are hard to track down. The downside to this implementation is that for every action Cypress must wait at least 2 run loops before applying actions. This slows down every action command by about `32ms`. If your app does not use animations you may wish to turn off this behavior in your `cypress.json` file. **Bugfixes:** @@ -128,7 +128,7 @@ **Features:** -- Added `responseTimeout` [configuration](https://on.cypress.io/guides/configuration) value. +- Added `responseTimeout` {% url 'configuration' configuration %} value. - {% url `cy.wait()` wait %} has been upgraded to now use two separate `timeout` values. In previous versions {% url `cy.wait()` wait %} used the `commandTimeout` and would automatically time out if the XHR did not achieve a response in that time frame. Now {% url `cy.wait()` wait %} will go through two independent timeout phases. At first {% url `cy.wait()` wait %} will wait for an XHR to be requested which matches its route. It will wait up to the value configured with `requestTimeout` (default 5000ms). After it sees a matching request it will then go into `response` waiting mode. It will wait up to the value configured with `responseTimeout` (default 20000ms). When {% url `cy.wait()` wait %} fails you now receive a much better error message indicating exactly which phase failed. Whether a request was never sent out, or whether it timed out waiting for a response. This gives you the best of both worlds and prevents situations where Cypress was timing out on slow servers. By creating new configuration values: `requestTimeout` and `responseTimeout` you can now directly control this behavior without affecting other regular commands. **Bugfixes:** @@ -218,7 +218,7 @@ **Features:** -- There are now [Getting Started](https://on.cypress.io/guides/installing-and-running) docs including [configuration options](https://on.cypress.io/guides/configuration) for `cypress.json` +- There are now [Getting Started](https://on.cypress.io/guides/installing-and-running) docs including {% url 'configuration' configuration %} for `cypress.json` - Cypress now silently restarts the server whenever it detects a change to `cypress.json` - meaning you no longer have to manually reboot the server for changes to be picked up. - There is a new {% url `Cypress.config` config %} interface - akin to {% url `Cypress.env` env %} which provides access to configuration values. @@ -231,7 +231,7 @@ **Misc:** -- Exposed `visitTimeout` and `requestTimeout` [configuration options](https://on.cypress.io/guides/configuration). +- Exposed `visitTimeout` and `requestTimeout` {% url 'configuration' configuration %}. - Increased `visitTimeout` from `20s` to `30s`. - {% url `.click()` click %} will now throw if you are attempting to click more than 1 element. Pass `{multiple: true}` to enable this behavior again. Each element will be clicked serially and inserted into the Command Log. diff --git a/docs/source/guides/appendices/changelog.md b/docs/source/guides/appendices/changelog.md index 182c3df9d9..5f3bdfd3eb 100644 --- a/docs/source/guides/appendices/changelog.md +++ b/docs/source/guides/appendices/changelog.md @@ -259,7 +259,7 @@ comments: false **Breaking Changes:** -- Previously, we auto-magically included all files within [`cypress/support`](https://on.cypress.io/guides/writing-your-first-test#section-folder-structure). This has now [gone away](https://on.cypress.io/guides/errors#section-the-supportfolder-option-has-been-removed) and we've simplified this to automatically including a single `cypress/support/index.js` file. That single file acts as the entry point meaning you should `import` or `require` the other support files you'd like to include. Although this is still "automatic" it's much less magical and we'll be updating all of our docs to reflect this. The purpose of `cypress/support` hasn't really changed, just the implementation of it has. We will automatically seed a `cypress/support/index.js` file for you (even on existing projects). The file location of `cypress/support/index.js` can be changed with the new [`supportFile`](https://on.cypress.io/guides/configuration#section-folders) option in your `cypress.json`. This feature can also be turned off by specifying `supportFile: false`. +- Previously, we auto-magically included all files within [`cypress/support`](https://on.cypress.io/guides/writing-your-first-test#section-folder-structure). This has now [gone away](https://on.cypress.io/guides/errors#section-the-supportfolder-option-has-been-removed) and we've simplified this to automatically including a single `cypress/support/index.js` file. That single file acts as the entry point meaning you should `import` or `require` the other support files you'd like to include. Although this is still "automatic" it's much less magical and we'll be updating all of our docs to reflect this. The purpose of `cypress/support` hasn't really changed, just the implementation of it has. We will automatically seed a `cypress/support/index.js` file for you (even on existing projects). The file location of `cypress/support/index.js` can be changed with the new {% url `supportFile` configuration#Folders %} option in your `cypress.json`. This feature can also be turned off by specifying `supportFile: false`. **Features:** @@ -271,7 +271,7 @@ comments: false - We improved the logic around when and if we scaffold files on a new project. We're much smarter about this and not generating these forcibly every time. Fixes [#285](https://github.com/cypress-io/cypress/issues/285). - Simplified handling of support files and made them less "magical". Fixes [#286](https://github.com/cypress-io/cypress/issues/286). -- Renamed `supportFolder` to [`supportFile`](https://on.cypress.io/guides/configuration#section-folders) in `cypress.json`. We will automatically rename your `cypress.json` if this property was present on update. +- Renamed `supportFolder` to {% url `supportFile` configuration#Folders %} in `cypress.json`. We will automatically rename your `cypress.json` if this property was present on update. # 0.17.12 @@ -316,8 +316,8 @@ comments: false - We no longer artificially restrict the environment [`cypress ci`](https://docs.cypress.io/docs/continuous-integration#section-what-is-the-difference-between-cypress-run-and-cypress-ci-) can run in. It can now run *anywhere*. Fixes [#296](https://github.com/cypress-io/cypress/issues/296). - We removed scaffolding any directories on a new project (when running headlessly). Fixes [#295](https://github.com/cypress-io/cypress/issues/295). - [`cypress run`](https://docs.cypress.io/docs/continuous-integration#section-what-is-the-difference-between-cypress-run-and-cypress-ci-) no longer prompts the user for any kind of interaction, thus enabling you to use this in CI if you choose to do so. Fixes [#294](https://github.com/cypress-io/cypress/issues/294). -- There is a new [configuration](https://on.cypress.io/guides/configuration) property called: `trashAssetsBeforeHeadlessRuns` that is set to `true` by default and will automatically clear out screenshots + videos folders before each run. These files are not deleted, they are just moved to your trash. -- There are several new [configuration](https://on.cypress.io/guides/configuration) properties for video recording: `videoRecording`, `videoCompression`, and `videosFolder`. +- There is a new {% url 'configuration' configuration %} property called: `trashAssetsBeforeHeadlessRuns` that is set to `true` by default and will automatically clear out screenshots + videos folders before each run. These files are not deleted, they are just moved to your trash. +- There are several new {% url 'configuration' configuration %} properties for video recording: `videoRecording`, `videoCompression`, and `videosFolder`. # 0.17.10 @@ -345,8 +345,8 @@ comments: false **Misc:** -- Changed default [`responseTimeout`](https://on.cypress.io/guides/configuration#section-timeouts) from `20000` to `30000`. -- Changed default [`pageLoadTimeout`](https://on.cypress.io/guides/configuration#section-timeouts) from `30000` to `60000`. +- Changed default {% url `responseTimeout` configuration#Timeouts %} from `20000` to `30000`. +- Changed default {% url `pageLoadTimeout` configuration#Timeouts %} from `30000` to `60000`. - The internal Cypress proxy now forcibly responds to requests taking longer than `responseTimeout`. Currently this sends back `text/html` with the `ETIMEDOUT` error, but this likely needs to be configurable. The reason we are now forcibly applying timeouts is to prevent `socket pooling exhaustion` where tests are running and a 3rd party server never responds to the request. # 0.17.8 @@ -370,7 +370,7 @@ comments: false **Features:** -- There is now a new [`chromeWebSecurity`](https://on.cypress.io/guides/configuration#section-browser) option you can set in `cypress.json` to turn off Chrome's Web Security features. We've written a brand new reference that details why and how you could use this. [Cypress Web Security](https://on.cypress.io/guides/web-security). This option can be used for accessing `cross origin` `` or if your application needs to test navigation across super domains. Fixes [#262](https://github.com/cypress-io/cypress/issues/262). +- There is now a new {% url `chromeWebSecurity` configuration#Browser %} option you can set in `cypress.json` to turn off Chrome's Web Security features. We've written a brand new reference that details why and how you could use this. [Cypress Web Security](https://on.cypress.io/guides/web-security). This option can be used for accessing `cross origin` `` or if your application needs to test navigation across super domains. Fixes [#262](https://github.com/cypress-io/cypress/issues/262). **Bugfixes:** @@ -501,7 +501,7 @@ comments: false **Bugfixes:** -- [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#section-timeouts) now works correctly. The driver was still referencing the old `commandTimeout` value. +- {% url `defaultCommandTimeout` configuration#Timeouts %} now works correctly. The driver was still referencing the old `commandTimeout` value. - The `__cypress.initial` cookie should now be removed during any {% url `cy.visit()` visit %}, which should fix some edge cases with the proxy accidentally injecting content when it shouldn't. We also added a ton more e2e tests covering these edge cases and other behavior. - The proxy now restricts it's injection to only `Content-Type: text/html` headers so it will not accidentally inject into the wrong responses. @@ -553,10 +553,10 @@ comments: false **Misc:** - [`cypress run`](https://github.com/cypress-io/cypress-cli#cypress-run-1) no longer requires being logged in. -- Renamed configuration option `commandTimeout` to [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#section-timeouts). Cypress will transparently rewrite this if you have it in your `cypress.json`, so you don't have to do anything. +- Renamed configuration option `commandTimeout` to {% url `defaultCommandTimeout` configuration %}. Cypress will transparently rewrite this if you have it in your `cypress.json`, so you don't have to do anything. - Renamed `onConsole` and `onRender` Command Log options to `consoleProps` and `renderProps`. We still support the older property names for backwards compatibility. - Added support for a command's `message` or `renderProps.message` to use markdown. -- The default value of `port` within a project's global [configuration](https://on.cypress.io/guides/configuration) has changed from `2020` to now being a random open port. You can still configure a specific `port` if needed within the [configuration](https://on.cypress.io/guides/configuration). +- The default value of `port` within a project's global {% url 'configuration' configuration %} has changed from `2020` to now being a random open port. You can still configure a specific `port` if needed within the {% url 'configuration' configuration %}. - We have upgraded the `Chromium` that runs headlessly on `cypress run` to version `51`. - The internal version of `node` which is built into Cypress is now `6.1.0`. - Cypress `.js` files are no longer minified to make them easier to debug. @@ -592,7 +592,7 @@ comments: false - {% url `cy.route()` route %} now accepts string glob patterns using [minimatch](https://github.com/isaacs/minimatch) under the hood. This means you can more easily route dynamic urls without using `regex`. Example: `cy.route('POST', '/users/*/comments', {})`. - {% url `Cypress.minimatch` minimatch %} is now exposed so you can easily test globbing patterns. - {% url `.type()` type %} can now be used on non-input elements that have a `tabindex` attribute. Key events will fire but no text content will change and no input based events fire. Fixes [#172](https://github.com/cypress-io/cypress/issues/172). -- There is now an [`ignoreTestFiles`](https://on.cypress.io/guides/configuration) configuration option that accepts an array of `glob` patterns. This enables you to ignore extraneous spec files that may be created during a build process. The default pattern is `*.hot-update.js` which will ignore dynamically generated webpack hot module swapping files. Fixes [#159](https://github.com/cypress-io/cypress/issues/159). +- There is now an {% url `ignoreTestFiles` configuration %} configuration option that accepts an array of `glob` patterns. This enables you to ignore extraneous spec files that may be created during a build process. The default pattern is `*.hot-update.js` which will ignore dynamically generated webpack hot module swapping files. Fixes [#159](https://github.com/cypress-io/cypress/issues/159). **Bugfixes:** @@ -614,8 +614,8 @@ comments: false **Features:** - Added new {% url `cy.screenshot()` screenshot %} command which can take screenshots on demand. -- When running headlessly or in CI Cypress will now automatically take a screenshot when a test fails. You can optionally turn this off by setting [`screenshotOnHeadlessFailure`](https://on.cypress.io/guides/configuration#section-global) to `false` in your [configuration](https://on.cypress.io/guides/configuration#section-global). -- Added new [`screenshotsFolder` configuration option](https://on.cypress.io/guides/configuration#section-folders) with default of `cypress/screenshots`. +- When running headlessly or in CI Cypress will now automatically take a screenshot when a test fails. You can optionally turn this off by setting {% url `screenshotOnHeadlessFailure` configuration#Screenshots %} to `false` in your configuration. +- Added new {% url `screenshotsFolder` configuration#Screenshots %} configuration option with default of `cypress/screenshots`. - When running in [Circle CI](https://circleci.com/), we automatically export screenshots as artifacts which makes them available directly in their web UI. If you're using Circle CI, you'll be able to see screenshots without doing anything. If you're using [Travis CI](https://travis-ci.org/), you'll need to upload artifacts to an `s3 bucket`. This is a small slice of what is coming to help diagnose and understand errors in CI. Also in `0.17.0` we will automatically scroll the tests and more intelligently and open / close test commands so you can visually see what happened. Currently you may not see the test command's failure in the Command Log due to the view not scrolling. - Added new {% url `.each()` each %} command which iterates serially on a collection yielding the iteratee, the index, and the collection. Addresses [#156](https://github.com/cypress-io/cypress/issues/156). - {% url `cy.route()` route %} can now accept a single function and/or you can pass a function to the `response` property. This allows you to lazily evaluate routing responses. Great for referencing [fixtures](https://on.cypress.io/guides/creating-fixtures). Addresses [#152](https://github.com/cypress-io/cypress/issues/152). @@ -686,8 +686,8 @@ comments: false - Added new commands to handle getting, setting, and clearing cookies: {% url `cy.clearCookie()` clearcookie %}, {% url `cy.getCookie()` getcookie %}, and {% url `cy.setCookie()` setcookie %}. - All the `cy.cookie` commands have been upgraded to take new options and can do much more powerful things outside of the JavaScript sandbox. - Upgraded the Chromium version running headlessly and in CI from `47` to `49`. -- There is a new {% url `cy.exec()` exec %} command that can execute any arbitrary system command. Additionally there is a new [`execTimeout` configurable option](https://on.cypress.io/guides/configuration#section-global) which is set to `60s` by default. Fixes [#126](https://github.com/cypress-io/cypress/issues/126). -- There is a new [`numTestsKeptInMemory` configuration option](https://on.cypress.io/guides/configuration#section-global) that controls how many test's snapshots and command data is kept in memory while tests are running. Reducing this number will reduce the memory used in the browser while tests are running. Whatever this number is - is how many tests you can walk back in time when inspecting their snapshots and return values. Addresses [#142](https://github.com/cypress-io/cypress/issues/142). +- There is a new {% url `cy.exec()` exec %} command that can execute any arbitrary system command. Additionally there is a new {% url `execTimeout` configuration#Timeouts %} configuration option which is set to `60s` by default. Fixes [#126](https://github.com/cypress-io/cypress/issues/126). +- There is a new {% url `numTestsKeptInMemory` configuration#Global %} configuration option that controls how many test's snapshots and command data is kept in memory while tests are running. Reducing this number will reduce the memory used in the browser while tests are running. Whatever this number is - is how many tests you can walk back in time when inspecting their snapshots and return values. Addresses [#142](https://github.com/cypress-io/cypress/issues/142). **Bugfixes:** @@ -775,8 +775,8 @@ comments: false **Features:** - The [error message when Cypress detects that a test has ended early](https://on.cypress.io/guides/errors#section-the-test-has-finished-but-cypress-still-has-commands-in-its-queue) (there are still commands left in the queue) now displays a list of these commands with a much improved explanation. -- There is now a new [configuration option](https://on.cypress.io/guides/configuration): `watchForFileChanges` that, when set to `false` in the `cypress.json`, will prevent Cypress from attempting to watch for file changes and restart your tests. -- You can now set the default [`reporter`](https://on.cypress.io/guides/configuration) in `cypress.json` for use when running headlessly or in CI. +- There is now a new {% url 'configuration option' configuration %}: `watchForFileChanges` that, when set to `false` in the `cypress.json`, will prevent Cypress from attempting to watch for file changes and restart your tests. +- You can now set the default {% url `reporter` configuration %} in `cypress.json` for use when running headlessly or in CI. **Bugfixes:** @@ -802,7 +802,7 @@ comments: false **Misc:** -- Renamed [configuration](https://on.cypress.io/guides/configuration) option `visitTimeout` to `pageLoadTimeout`. You don't need to change anything. If you were specifically setting `visitTimeout` in your `cypress.json` file it will be transparently rewritten `pageLoadTimeout` on the next server boot. This option was renamed because now multiple commands `cy.visit()`, `cy.go()`, and `cy.reload()` all depend on this timeout option. +- Renamed {% url 'configuration' configuration %} option `visitTimeout` to `pageLoadTimeout`. You don't need to change anything. If you were specifically setting `visitTimeout` in your `cypress.json` file it will be transparently rewritten `pageLoadTimeout` on the next server boot. This option was renamed because now multiple commands `cy.visit()`, `cy.go()`, and `cy.reload()` all depend on this timeout option. - The Cypress tray icon has been updated. It's much better now. # 0.15.0 @@ -825,9 +825,9 @@ comments: false **Breaking Changes:** - Cypress no longer looks at your `tests` directory for test files. Now, by default, it looks in the `cypress/integration` directory. -- We've removed the [configuration option](https://on.cypress.io/guides/configuration) `testFolder` and renamed it to `integrationFolder` inside of the `cypress.json`. +- We've removed the configuration option `testFolder` and renamed it to {% url `integrationFolder` configuration#Folders %} inside of the `cypress.json`. - We've renamed the `cypress` npm package to be [`cypress-cli`](https://github.com/cypress-io/cypress-cli). You'll see a giant deprecation warning until your scripts have been updated to reference `cypress-cli`. [More info here](https://www.npmjs.com/package/cypress). You can also uninstall the `cypress` npm package. -- Added new `fileServerFolder` [configuration option](https://on.cypress.io/guides/configuration) that can mount a directory other than your project root when using Cypress as a webserver. +- Added new {% url `fileServerFolder` configuration#Folders %} configuration option that can mount a directory other than your project root when using Cypress as a webserver. **Misc:** diff --git a/docs/source/guides/appendices/configuration.md b/docs/source/guides/appendices/configuration.md index cebb7464c9..f18ae1635e 100644 --- a/docs/source/guides/appendices/configuration.md +++ b/docs/source/guides/appendices/configuration.md @@ -110,7 +110,7 @@ cypress run --record --config viewportWidth=1280,viewportHeight=720 ## Environment Variables -You can also use [environment variables](https://on.cypress.io/guides/environment-variables) to override configuration values. This is especially useful in [CI](https://on.cypress.io/guides/continuous-integration) or when working locally. This gives you the ability to change configuration options without modifying any code or build scripts. +You can also use [environment variables](https://on.cypress.io/guides/environment-variables) to override configuration values. This is especially useful in {% url 'Continuous Integration' continuous-integration %} or when working locally. This gives you the ability to change configuration options without modifying any code or build scripts. By default, any environment variable that matches a corresponding configuration key will override the `cypress.json` value. diff --git a/docs/source/guides/appendices/error-messages.md b/docs/source/guides/appendices/error-messages.md index f5bf042e83..54bb53ddb6 100644 --- a/docs/source/guides/appendices/error-messages.md +++ b/docs/source/guides/appendices/error-messages.md @@ -29,7 +29,7 @@ When the error is fixed in your test file, your tests will automatically re-run. **{% fa fa-exclamation-triangle red %} Support file missing or invalid** -The `supportFolder` option was removed from Cypress in version [0.18.0](https://on.cypress.io/guides/changelog#0-18-0) and was replaced by module support and the [`supportFile`](https://on.cypress.io/guides/configuration) configuration option. +The `supportFolder` option was removed from Cypress in version [0.18.0](https://on.cypress.io/guides/changelog#0-18-0) and was replaced by module support and the {% url `supportFile` configuration#Folders %} configuration option. Cypress used to automatically include any scripts in the `supportFolder` before your test files. However, automatically including all the files in a certain directory is somewhat magical and unintuitive, and requires creating globals for the purpose of utility functions. @@ -198,7 +198,7 @@ Cypress will continuously attempt to interact with the element until it eventual cy.get('#modal button').click({waitForAnimations: false}) ``` -You can globally disable animation error checking, or increase the threshold by modifying the [configuration options](https://on.cypress.io/guides/configuration) in your [`cypress.json`](https://on.cypress.io/guides/configuration). +You can globally disable animation error checking, or increase the threshold by modifying the {% url 'configuration' configuration %} in your {% url 'configuration' configuration %}. ***cypress.json*** diff --git a/docs/source/guides/core-concepts/dealing-with-the-network.md b/docs/source/guides/core-concepts/dealing-with-the-network.md index a8708741ad..4abc9963a5 100644 --- a/docs/source/guides/core-concepts/dealing-with-the-network.md +++ b/docs/source/guides/core-concepts/dealing-with-the-network.md @@ -114,7 +114,7 @@ Cypress automatically indicates when an XHR request happens in your application. ![snapshot_request](https://user-images.githubusercontent.com/1271364/26947393-930508b0-4c60-11e7-90a0-4d42ee3f24c0.gif) -By default, Cypress is configured to *ignore* requests that are used to fetch static content like `.js` or `.html` files. This keeps the Command Log less noisy. This option can be changed in the [configuration](https://on.cypress.io/guides/configuration). +By default, Cypress is configured to *ignore* requests that are used to fetch static content like `.js` or `.html` files. This keeps the Command Log less noisy. This option can be changed in the {% url 'configuration' configuration %}. Cypress automatically collects the request `headers` and the request `body` and will make this available to you. diff --git a/docs/source/guides/core-concepts/organizing-tests.md b/docs/source/guides/core-concepts/organizing-tests.md index 10f93403ce..6fd3f39dfe 100644 --- a/docs/source/guides/core-concepts/organizing-tests.md +++ b/docs/source/guides/core-concepts/organizing-tests.md @@ -49,7 +49,7 @@ Cypress also adds placeholder files to help get you started with examples in eac While Cypress allows for configuration of where your tests, fixtures, and support files are located, if you're starting your first project, we recommend you use the above structure. -You can modify the folder configuration in your `cypress.json`. See [configuration](https://on.cypress.io/guides/configuration) for more detail. +You can modify the folder configuration in your `cypress.json`. See {% url 'configuration' configuration %} for more detail. # Test Files diff --git a/docs/source/guides/integrating-cypress/cli-tool.md b/docs/source/guides/integrating-cypress/cli-tool.md index afc2a49484..b890a5ed53 100644 --- a/docs/source/guides/integrating-cypress/cli-tool.md +++ b/docs/source/guides/integrating-cypress/cli-tool.md @@ -123,7 +123,7 @@ You can read more about [environment variables](https://on.cypress.io/environmen Record video of tests running after [setting up your project to record](https://on.cypress.io/guides/projects). {% note info %} -You'd typically record your runs in [Continuous Integration](https://on.cypress.io/guides/continuous-integration), but you can also record when running locally. +You'd typically record your runs in {% url 'Continuous Integration' continuous-integration %}, but you can also record when running locally. {% endnote %} After setting up your project you will be given a **Record Key**. @@ -136,7 +136,7 @@ cypress run --record --key If you set the **Record Key** as the environment variable `CYPRESS_RECORD_KEY`, you can omit the `--key` flag. -**Set environment variable (typically in [CI](https://on.cypress.io/guides/continuous-integration)).** +**Set environment variable (typically in {% url 'Continuous Integration' continuous-integration %}).** ```shell export CYPRESS_RECORD_KEY=abc-key-123 diff --git a/docs/source/guides/integrating-cypress/dashboard-projects.md b/docs/source/guides/integrating-cypress/dashboard-projects.md index d6eb18ffa1..ecea1e2789 100644 --- a/docs/source/guides/integrating-cypress/dashboard-projects.md +++ b/docs/source/guides/integrating-cypress/dashboard-projects.md @@ -49,7 +49,7 @@ During a run we record all failing tests, logs, screenshots, and videos and make ![screen shot 2017-02-12 at 3 46 30 pm](https://cloud.githubusercontent.com/assets/1268976/22866093/64a9fb4c-f13e-11e6-9ebe-980ec078ba4e.png) -Your tests runs are now ready to record. Typically you would record your runs when running in [Continuous Integration](https://on.cypress.io/guides/continuous-integration) but you can also record your runs from your local computer. +Your tests runs are now ready to record. Typically you would record your runs when running in {% url 'Continuous Integration' continuous-integration %} but you can also record your runs from your local computer. ## Record Test Runs diff --git a/docs/source/guides/integrating-cypress/environment-variables.md b/docs/source/guides/integrating-cypress/environment-variables.md index 4f079f00a9..22916d6604 100644 --- a/docs/source/guides/integrating-cypress/environment-variables.md +++ b/docs/source/guides/integrating-cypress/environment-variables.md @@ -39,7 +39,7 @@ When your tests are running, you can use the {% url `Cypress.env` env %} functio ## Option #1: `cypress.json` -Any key/value you set in your [`cypress.json`](https://on.cypress.io/guides/configuration) under the `env` key will become an environment variable. +Any key/value you set in your {% url 'configuration' configuration %} under the `env` key will become an environment variable. ***cypress.json***