mirror/cypress
1
0
Fork 0
mirror of https://github.com/cypress-io/cypress.git synced 2026-05-24 09:29:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: rename fields for clarity

Browse Source 
- Notes -> Description
- Default -> Defaults
- Timeout -> Timeouts
This commit is contained in:
Brian Mann
2017-06-25 13:56:21 -04:00
parent 7cba8aa696
commit 669790bec2
79 changed files with 146 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/api/commands/_scrollintoview.md
+2 -2
View File
@@ -36,7 +36,7 @@ cy.window().scrollIntoView() // Errors, 'window' does not yield DOM element
Pass in an options object to change the default behavior of `.scrollIntoView()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`duration` | `0` | Scrolls over the duration (in ms)
@@ -48,7 +48,7 @@ Option | Default | Notes
`.scrollIntoView()` yields the DOM element that was scrolled into view.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.scrollIntoView()` will continue to scroll the element into view for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/_scrollto.md
+2 -2
View File
@@ -49,7 +49,7 @@ The distance in pixels from window/element's top or percentage of the window/ele
Pass in an options object to change the default behavior of `cy.scrollTo()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`duration` | `0` | Scrolls over the duration (in ms)
@@ -60,7 +60,7 @@ Option | Default | Notes
`cy.scrollTo()` yields the window or DOM element that was scrolled.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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.
docs/source/api/commands/_trigger.md
+2 -2
View File
@@ -57,7 +57,7 @@ The distance in pixels from element's top to trigger the event.
Pass in an options object to change the default behavior of `.trigger()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`bubbles` | `true` | Whether the event bubbles
@@ -70,7 +70,7 @@ You can also include arbitrary event properties (e.g. `clientX`, `shiftKey`) and
`.trigger()` yields the DOM subject chained from the previous command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.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.
docs/source/api/commands/and.md
+1 -1
View File
@@ -76,7 +76,7 @@ cy
.and('have.css', 'font-family') // yields 'sans-serif'
```
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.and()` will continue to retry until none of the assertions throw for the duration of the previous cy commands `timeout`.
docs/source/api/commands/as.md
+1 -1
View File
@@ -44,7 +44,7 @@ The name of the alias to be referenced later within a {% url `cy.get()` get %} o
`.as()` yields the DOM element or route chained from the previous command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.as()` will retry the chain of commands before the `.as()` command for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}
docs/source/api/commands/blur.md
+1 -1
View File
@@ -48,7 +48,7 @@ Option | Default | Notes
`.blur()` yields the DOM element that was blurred.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.blur()` will continue to look for the focusable element to blur for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/check.md
+2 -2
View File
@@ -48,7 +48,7 @@ Values of checkboxes or radios that should be checked.
Pass in an options object to change the default behavior of `.check()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`force` | `false` | {% usage_options force check %}
@@ -58,7 +58,7 @@ Option | Default | Notes
`.check()` yields the same subject from the previous command.
## Default {% helper_icon defaultAssertion %}
## Defaults {% helper_icon defaultAssertion %}
`.check()` yields the DOM element(s) that were checked.
docs/source/api/commands/children.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.children()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .children %}
@@ -50,7 +50,7 @@ Option | Default | Notes
`.children()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.children()` will continue to look for the children elements for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/clear.md
+2 -2
View File
@@ -42,7 +42,7 @@ cy.url().clear() // Errors, 'url' doesn't yield DOM element
Pass in an options object to change the default behavior of `.clear()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`force` | `false` | {% usage_options force clear %}
@@ -52,7 +52,7 @@ Option | Default | Notes
`.clear()` yields the `input` or `textarea` that was cleared.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.clear()` will continue to look for the `input` or `textarea` for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/clearcookie.md
+2 -2
View File
@@ -37,7 +37,7 @@ The name of the cookie to be cleared.
Pass in an options object to change the default behavior of `cy.clearCookie()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.clearCookie %}
@@ -46,7 +46,7 @@ Option | Default | Notes
`cy.clearCookie()` yields `null`.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.clearCookie()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process the command.
docs/source/api/commands/clearcookies.md
+2 -2
View File
@@ -32,7 +32,7 @@ cy.clearCookies() // clear all cookies
Pass in an options object to change the default behavior of `cy.clearCookies()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.clearCookies %}
@@ -41,7 +41,7 @@ Option | Default | Notes
`cy.clearCookies()` yields `null`.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.clearCookies()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process this command.
docs/source/api/commands/clearlocalstorage.md
+2 -2
View File
@@ -38,7 +38,7 @@ Specify key to be cleared in local storage.
Pass in an options object to change the default behavior of `cy.clearCookies()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.clearLocalStorage %}
@@ -47,7 +47,7 @@ Option | Default | Notes
`cy.clearLocalStorage()` yields the remove local storage object.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.clearLocalStorage()` will wait up for the duration of {% url `defaultCommandTimeout` configuration#Timeouts %} to process this command.
docs/source/api/commands/click.md
+2 -2
View File
@@ -55,7 +55,7 @@ The distance in pixels from the element's top to issue the click.
Pass in an options object to change the default behavior of `.click()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`force` | `false` | {% usage_options force click %}
@@ -66,7 +66,7 @@ Option | Default | Notes
`.click()` yields the element that was clicked.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.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.
docs/source/api/commands/clock.md
+2 -2
View File
@@ -48,7 +48,7 @@ Name of native functions that clock should override.
Pass in an options object to change the default behavior of `cy.clock()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
@@ -66,7 +66,7 @@ Option | Default | Notes
You can also access the `clock` object via `this.clock` in a {% url `.then()` then %} callback.
## Timeout
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/closest.md
+2 -2
View File
@@ -39,7 +39,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.closest()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .closest %}
@@ -48,7 +48,7 @@ Option | Default | Notes
`.closest()` yields the new DOM elements found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.closest()` will continue to look for the closest element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/contains.md
+2 -2
View File
@@ -45,7 +45,7 @@ Specify a selector to filter DOM elements containing the text. Cypress will *ign
Pass in an options object to change the default behavior of `cy.contains()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .contains %}
@@ -54,7 +54,7 @@ Option | Default | Notes
`cy.contains()` yields the *first*, *deepest* DOM element containing the text.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.contains()` will try to find the content within the DOM for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/dblclick.md
+2 -2
View File
@@ -37,7 +37,7 @@ cy.window().click() // Errors, 'window' does not yield DOM element
Pass in an options object to change the default behavior of `.dblclick()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .dblclick %}
@@ -46,7 +46,7 @@ Option | Default | Notes
`.dblclick()` yields the DOM element that was double clicked.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.dblclick()` will wait for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/debug.md
+2 -2
View File
@@ -33,7 +33,7 @@ cy.get('nav').debug() // Debug the `get` command's yield
Pass in an options object to change the default behavior of `.debug()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
@@ -41,7 +41,7 @@ Option | Default | Notes
`.debug()` yields the previous command's yield.
## Timeout
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/document.md
+2 -2
View File
@@ -28,7 +28,7 @@ cy.document() // yield the window.document object
Pass in an options object to change the default behavior of `cy.document()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.document %}
@@ -37,7 +37,7 @@ Option | Default | Notes
`cy.document()` yields the `window.document` object.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.document()` will retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/each.md
+1 -1
View File
@@ -44,7 +44,7 @@ Pass a function that is invoked with the following arguments:
`.each()` yields the same subject passed to it (the current array).
## Timeout
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/end.md
+1
View File
@@ -32,6 +32,7 @@ cy.end() // Does not make sense to chain off 'cy'
`.end()` yields `null`.
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/eq.md
+2 -2
View File
@@ -46,7 +46,7 @@ A negative number indicating the index position from the end to find the element
Pass in an options object to change the default behavior of `.eq()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .eq %}
@@ -55,7 +55,7 @@ Option | Default | Notes
`.eq()` yields the new DOM elements found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.eq()` will continue to look for the element at the specified index for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/exec.md
+2 -2
View File
@@ -32,7 +32,7 @@ The system command to be executed from the project root (the directory that cont
Pass in an options object to change the default behavior of `cy.exec()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`env` | `{}` | Object of environment variables to set before the command executes (e.g. `{USERNAME: 'johndoe'}`). Will be merged with existing system environment variables
@@ -47,7 +47,7 @@ Option | Default | Notes
- `stdout`
- `stderr`
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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.
docs/source/api/commands/filter.md
+2 -2
View File
@@ -43,7 +43,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.filter()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .filter %}
@@ -52,7 +52,7 @@ Option | Default | Notes
`.filter()` yields the new DOM elements found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.filter()` will continue to look for the filtered element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/find.md
+2 -2
View File
@@ -39,7 +39,7 @@ A selector used to filter matching descendent DOM elements.
Pass in an options object to change the default behavior of `.find()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .find %}
@@ -48,7 +48,7 @@ Option | Default | Notes
`.find()` yields the new DOM elements found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.find()` will continue to look for the filtered element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/first.md
+2 -2
View File
@@ -35,7 +35,7 @@ cy.getCookies().first() // Errors, 'getCookies' does not yield DOM element
Pass in an options object to change the default behavior of `.first()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .first %}
@@ -44,7 +44,7 @@ Option | Default | Notes
`.first()` yields the new DOM element found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.first()` will continue to look for the first element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/fixture.md
+2 -2
View File
@@ -59,7 +59,7 @@ The encoding to be used when reading the file. The following encodings are suppo
Pass in an options object to change the default behavior of `cy.fixture()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.fixture %}
@@ -67,7 +67,7 @@ Option | Default | Notes
`cy.fixture()` yields the contents of the file. Formatting is determined by it's file extension.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.fixture` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the server to process the command.
docs/source/api/commands/focus.md
+2 -2
View File
@@ -35,7 +35,7 @@ cy.window().focus() // Errors, 'window' does not yield DOM element
Pass in an options object to change the default behavior of `.focus()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .focus %}
@@ -44,7 +44,7 @@ Option | Default | Notes
`.focus()` yields the new DOM element that was focused.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.focus()` will continue to try to focus the element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/focused.md
+2 -2
View File
@@ -28,7 +28,7 @@ cy.focused()
Pass in an options object to change the default behavior of `cy.focused()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.focused %}
@@ -37,7 +37,7 @@ Option | Default | Notes
`cy.focused()` yields the DOM element that is currently focused.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.focused()` will continue to look for the focused element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/get.md
+2 -2
View File
@@ -44,7 +44,7 @@ Internally, Cypress keeps a cache of all aliased elements. If the element curre
Pass in an options object to change the default behavior of `cy.get()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.get %}
@@ -53,7 +53,7 @@ Option | Default | Notes
`cy.get()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.get()` will continue to look for the elements for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/getcookie.md
+2 -2
View File
@@ -32,7 +32,7 @@ The name of the cookie to get.
Pass in an options object to change the default behavior of `cy.getCookie()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.getCookie %}
@@ -49,7 +49,7 @@ Option | Default | Notes
- `secure`
- `expiry`
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.getCookie()` will continue to look for the cookie for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/getcookies.md
+2 -2
View File
@@ -28,7 +28,7 @@ cy.getCookies() // Get all cookies
Pass in an options object to change the default behavior of `cy.getCookies()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.getCookies %}
@@ -45,7 +45,7 @@ Option | Default | Notes
- `secure`
- `expiry`
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.getCookies()` will continue to look for cookies for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/go.md
+2 -2
View File
@@ -35,7 +35,7 @@ You can use `back` or `forward` to go one step back or forward. You could also n
Pass in an options object to change the default behavior of `cy.go()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `pageLoadTimeout` configuration#Timeouts %} | {% usage_options timeout cy.go %}
@@ -44,7 +44,7 @@ Option | Default | Notes
`cy.go()` yields the `window` object.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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.
docs/source/api/commands/hash.md
+2 -2
View File
@@ -34,7 +34,7 @@ Pass in an options object to change the default behavior of `cy.hash()`.
**cy.hash( *options* )**
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.hash %}
@@ -43,7 +43,7 @@ Option | Default | Notes
`cy.hash()` yields the current URL hash as a string including the `#` character. If no `#` character is present in the URL, then an empty string will be returned.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/invoke.md
+1 -1
View File
@@ -48,7 +48,7 @@ Additional arguments to be given to the function call. There is no limit to the
`.invoke()` yields the return value of the invoked property.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/its.md
+1 -1
View File
@@ -43,7 +43,7 @@ Name of property or nested properties (with dot notation) to get.
`.invoke()` yields the value of the property.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/last.md
+2 -2
View File
@@ -35,7 +35,7 @@ cy.getCookies().last() // Errors, 'getCookies' does not yield DOM element
Pass in an options object to change the default behavior of `.last()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .last %}
@@ -44,7 +44,7 @@ Option | Default | Notes
`.last()` yields the new DOM element found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.last()` will continue to look for the last element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/location.md
+2 -2
View File
@@ -34,7 +34,7 @@ A key on the location object.
Pass in an options object to change the default behavior of `cy.location()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.location %}
@@ -54,7 +54,7 @@ Option | Default | Notes
- `search`
- `toString`
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/log.md
+1 -1
View File
@@ -36,7 +36,7 @@ Additional arguments to be printed to the Cypress Command Log. There is no limit
`cy.log()` yields `null`.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/next.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.next()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .next %}
@@ -50,7 +50,7 @@ Option | Default | Notes
`.next()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.next()` will continue to look for the next element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/nextall.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.nextAll()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .nextAll %}
@@ -50,7 +50,7 @@ Option | Default | Notes
`.nextAll()` yields the new DOM elements found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.nextAll()` will continue to look for all next element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/nextuntil.md
+2 -2
View File
@@ -52,7 +52,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.nextUntil()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .nextUntil %}
@@ -61,7 +61,7 @@ Option | Default | Notes
`.nextUntil()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.nextUntil()` will continue to look for the next element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/not.md
+2 -2
View File
@@ -43,7 +43,7 @@ A selector used to remove matching DOM elements.
Pass in an options object to change the default behavior of `.not()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .not %}
@@ -52,7 +52,7 @@ Option | Default | Notes
`.not()` yields the new DOM element(s) without the selector provided in the command's argument.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.not()` will continue to look for the element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/parent.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.parent()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .parent %}
@@ -50,7 +50,7 @@ Option | Default | Notes
`.parent()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.parent()` will continue to look for the parent element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/parents.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.parents()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .parents %}
@@ -51,7 +51,7 @@ Option | Default | Notes
`.parents()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.parents()` will continue to look for the next element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/parentsuntil.md
+2 -2
View File
@@ -51,7 +51,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.parentsUntil()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .parentsUntil %}
@@ -60,7 +60,7 @@ Option | Default | Notes
`.parentsUntil()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.parentsUntil()` will continue to look for the parent element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/pause.md
+2 -2
View File
@@ -33,7 +33,7 @@ cy.get('nav').pause() // Pause after the 'get' commands yield
Pass in an options object to change the default behavior of `.pause()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
@@ -41,7 +41,7 @@ Option | Default | Notes
`.pause()` yields the previous command's yield.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/prev.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.prev()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .prev %}
@@ -50,7 +50,7 @@ Option | Default | Notes
`.prev()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.prev()` will continue to look for the previous element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/prevall.md
+2 -2
View File
@@ -41,7 +41,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.prevAll()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .prevAll %}
@@ -50,7 +50,7 @@ Option | Default | Notes
`.prevAll()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.prevAll()` will continue to look for the previous elements for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/prevuntil.md
+2 -2
View File
@@ -51,7 +51,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.prevUntil()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .prevUntil %}
@@ -60,7 +60,7 @@ Option | Default | Notes
`.prevUntil()` yields the new DOM element(s) found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.prevUntil()` will continue to look for the previous element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/readfile.md
+2 -2
View File
@@ -50,7 +50,7 @@ The encoding to be used when reading the file. The following encodings are suppo
Pass in an options object to change the default behavior of `cy.readFile()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.readFile %}
@@ -59,7 +59,7 @@ Option | Default | Notes
`cy.readFile()` yields the contents of the file.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.readFile()` will wait up for the duration of {% url `defaultCommandTimeout` configuration#Timeouts %} for the server to process the command.
docs/source/api/commands/reload.md
+2 -2
View File
@@ -32,7 +32,7 @@ Whether to reload the current page without using the cache. `true` forces the re
**{% fa fa-angle-right %} options** ***(Object)***
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `pageLoadTimeout` configuration#Timeouts %} | {% usage_options timeout cy.reload %}
@@ -41,7 +41,7 @@ Option | Default | Notes
`cy.reload()` yields the `window` object of the newly loaded page.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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.
docs/source/api/commands/request.md
+2 -2
View File
@@ -68,7 +68,7 @@ Make a request using a specific method (`GET`, `POST`, `PUT`, etc). If no method
Pass in an options object to change the default behavior of `cy.request`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`url` | `null` | The URL to make the request to
@@ -94,7 +94,7 @@ You can also set options for `cy.request`'s `baseUrl` and `responseTimeout` glob
- `headers`
- `duration`.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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.
docs/source/api/commands/root.md
+2 -2
View File
@@ -31,7 +31,7 @@ cy.get('nav').within(function(nav) {
Pass in an options object to change the default behavior of `.root()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.root %}
@@ -42,7 +42,7 @@ Option | Default | Notes
The root element yielded is `document` by default. However, when calling `.root()` from within the callback function of a {% url `.within()` within %} command, the root element yielded is the yielded subject of the {% url `.within()` within %} command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.root()` will continue to look for the root element for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/route.md
+2 -2
View File
@@ -52,7 +52,7 @@ Set a route by returning an object literal from a callback function. Functions t
Pass in an options object to change the default behavior of `cy.route()`. By default `cy.route()` inherits its options from {% url `cy.server()` server %}.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`delay` | `0` | Delay for stubbed responses (in ms)
`force404` | `false` | Forcibly send XHR's a 404 status when the XHR's do not match any existing {% url `cy.route()` route %}.
@@ -69,7 +69,7 @@ You can also set options for all {% url `cy.wait()` wait %}'s `requestTimeout` a
## Yields {% helper_icon yields %}
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/screenshot.md
+2 -2
View File
@@ -34,7 +34,7 @@ A name for the image file. By default the filename will be the title of the test
Pass in an options object to change the default behavior of `cy.screenshot()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.screenshot %}
@@ -43,7 +43,7 @@ Option | Default | Notes
`cy.screenshot()` yields `null`.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.screenshot()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process this command.
docs/source/api/commands/select.md
+2 -2
View File
@@ -45,7 +45,7 @@ An array of `values` or text contents of the `<option>`s to be selected.
Pass in an options object to change the default behavior of `.select()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`force` | `false` | `log` | `true` | {% usage_options force select %}
@@ -55,7 +55,7 @@ Option | Default | Notes
`.select()` yields the new DOM elements selected.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.select()` will continue to select the options for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/server.md
+3 -3
View File
@@ -39,7 +39,7 @@ Pass in an options object to change the default behavior of `cy.server()`. These
***The following options are merged in as default options to {% url `cy.route()` route %}***
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`delay` | `0` | delay for stubbed responses (in ms)
`headers` | `null` | response headers for stubbed routes
@@ -52,7 +52,7 @@ Option | Default | Notes
***The following options control the behavior of the server affecting all requests:***
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`enable` | `true` | pass `false` to disable existing route stubs
`force404` | `false` | forcibly send XHR's a 404 status when the XHR's do not match any existing
@@ -63,7 +63,7 @@ Option | Default | Notes
`cy.server()` yields the Cypress server instance.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/setcookie.md
+2 -2
View File
@@ -36,7 +36,7 @@ The value of the cookie to set.
Pass in an options object to change the default behavior of `cy.setCookie()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`domain` | `window.location.hostname` | The domain the cookie is visible to
@@ -58,7 +58,7 @@ Option | Default | Notes
- `secure`
- `expiry`
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.setCookie()` will wait up for the duration of {% url `responseTimeout` configuration#Timeouts %} for the automation server to process this command.
docs/source/api/commands/should.md
+1 -1
View File
@@ -76,7 +76,7 @@ cy
.should('have.css', 'font-family') // yields 'sans-serif'
```
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.should()` will continue to retry until none of the assertions throw for the duration of the previous cy commands `timeout`.
docs/source/api/commands/siblings.md
+2 -2
View File
@@ -42,7 +42,7 @@ A selector used to filter matching DOM elements.
Pass in an options object to change the default behavior of `.siblings()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .siblings %}
@@ -51,7 +51,7 @@ Option | Default | Notes
`.siblings()` yields the new DOM elements found by the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.siblings()` will continue to look for the sibling element(s) for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/spread.md
+2 -2
View File
@@ -43,7 +43,7 @@ Pass a function that expands the array into it's arguments.
Pass in an options object to change the default behavior of `.spread()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .spread %}
@@ -51,7 +51,7 @@ Option | Default | Notes
Whatever was passed to the function is what is yielded.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/spy.md
+1 -1
View File
@@ -41,7 +41,7 @@ Unlike most Cypress commands, `cy.spy()` is *synchronous* and returns a value (t
`cy.spy()` returns a [Sinon.js spy](http://sinonjs.org/docs/#spies). All [methods](http://sinonjs.org/docs/#spies-api) found on Sinon.JS spies are supported.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/stub.md
+1 -1
View File
@@ -47,7 +47,7 @@ Unlike most Cypress commands, `cy.stub()` is *synchronous* and returns a value (
`cy.stub()` returns a {% url "Sinon.js stub" http://sinonjs.org/%}. All methods found on {% url "Sinon.js" http://sinonjs.org %} spies and stubs are supported.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/submit.md
+2 -2
View File
@@ -35,7 +35,7 @@ cy.get('input').submit() // Errors, 'input' does not yield a form
Pass in an options object to change the default behavior of `.submit()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .submit %}
@@ -44,7 +44,7 @@ Option | Default | Notes
`.submit()` yields the form that was submitted.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.submit()` will continue to try to submit the form for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/then.md
+2 -2
View File
@@ -33,7 +33,7 @@ Pass a function that takes the previously yielded subject as it's first argument
Pass in an options object to change the default behavior of `.then()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .then %}
@@ -45,7 +45,7 @@ When `null` or `undefined` are returned by the callback function, the subject wi
Just like Promises, you can return any compatible "thenable" (anything that has a `.then()` interface) and Cypress will wait for that to resolve before continuing forward through the chain of commands.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.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).
docs/source/api/commands/title.md
+2 -2
View File
@@ -28,7 +28,7 @@ cy.title()
Pass in an options object to change the default behavior of `cy.title()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.title %}
@@ -37,7 +37,7 @@ Option | Default | Notes
`cy.title()` yields the `document` title as a string.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.title()` will continue to retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}
docs/source/api/commands/type.md
+2 -2
View File
@@ -63,7 +63,7 @@ Sequence | Notes
Pass in an options object to change the default behavior of `.type()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`delay` | `10` | Delay after each keypress
@@ -75,7 +75,7 @@ Option | Default | Notes
`.type()` yields the DOM element that was typed into.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`.type()` will continue to retry typing for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/uncheck.md
+1 -1
View File
@@ -47,7 +47,7 @@ Values of checkboxes that should be unchecked.
Pass in an options object to change the default behavior of `.uncheck()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`force` | `false` | {% usage_options force uncheck %}
docs/source/api/commands/url.md
+2 -2
View File
@@ -34,7 +34,7 @@ Pass in an options object to change the default behavior of `cy.url()`.
**cy.hash( *options* )**
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.url %}
@@ -43,7 +43,7 @@ Option | Default | Notes
`cy.url()` yields the current URL as a string.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/viewport.md
+2 -2
View File
@@ -64,7 +64,7 @@ The orientation of the screen. The *default orientation* is `portrait`. Pass `la
Pass in an options object to change the default behavior of `cy.viewport()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
@@ -72,7 +72,7 @@ Option | Default | Notes
`cy.viewport()` yields `null`.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/visit.md
+2 -2
View File
@@ -32,7 +32,7 @@ The url to visit. The url provided will be prefixed with the `baseUrl` configure
Pass in an options object to change the default behavior of `cy.visit()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`onBeforeLoad` | `function` | Called before your page has loaded all of its resources.
@@ -45,7 +45,7 @@ You can also set all `cy.visit()` commands' `pageLoadTimeout` and `baseUrl` glob
`cy.visit()` yields the remote `window` object.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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).
docs/source/api/commands/wait.md
+2 -2
View File
@@ -49,7 +49,7 @@ An array of aliased routes as defined using the {% url `.as()` as %} command and
Pass in an options object to change the default behavior of `cy.wait()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `requestTimeout` configuration#Timeouts %}, {% url `responseTimeout` configuration#Timeouts %} | {% usage_options timeout cy.wait %}
@@ -60,7 +60,7 @@ When given a `time` argument, `cy.wait()` yields the previous commands yield.
When given an `alias` argument, `cy.wait()` yields the XHR object of the aliased route.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`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).
docs/source/api/commands/window.md
+2 -2
View File
@@ -28,7 +28,7 @@ cy.window()
Pass in an options object to change the default behavior of `cy.window()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.window %}
@@ -37,7 +37,7 @@ Option | Default | Notes
`cy.window()` yields the `window` object.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.window()` will retry for the duration of the {% url `defaultCommandTimeout` configuration#Timeouts %}.
docs/source/api/commands/within.md
+2 -2
View File
@@ -39,13 +39,13 @@ Pass a function that takes the current yielded subject as it's first argument.
Pass in an options object to change the default behavior of `.within()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
## Yields {% helper_icon yields %}
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/wrap.md
+2 -2
View File
@@ -32,7 +32,7 @@ An object to be yielded.
Pass in an options object to change the default behavior of `cy.wrap()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.wrap %}
@@ -41,7 +41,7 @@ Option | Default | Notes
`cy.wrap()` yields the object that was passed into the command.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
# Examples
docs/source/api/commands/writefile.md
+2 -2
View File
@@ -54,7 +54,7 @@ The encoding to be used when writing to the file. The following encodings are su
Pass in an options object to change the default behavior of `cy.writeFile()`.
Option | Default | Notes
Option | Default | Description
--- | --- | ---
`log` | `true` | {% usage_options log %}
`timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout cy.writeFile %}
@@ -63,7 +63,7 @@ Option | Default | Notes
`cy.writeFile()` yields the contents written to the file.
## Timeout {% helper_icon timeout %}
## Timeouts {% helper_icon timeout %}
`cy.writeFile()` will wait up for the duration of {% url `defaultCommandTimeout` configuration#Timeouts %} for the server to write to the file.