mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-18 22:28:38 -05:00
Jennifer Mann
69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
---
|
|
title: window
|
|
comments: true
|
|
description: ''
|
|
---
|
|
|
|
Get the global `window` object of the remote application [visited](https://on.cypress.io/api/visit).
|
|
|
|
| | |
|
|
|--- | --- |
|
|
| **Returns** | the `window` object |
|
|
| **Timeout** | `cy.window` will retry for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) |
|
|
|
|
# [cy.window()](#usage)
|
|
|
|
Get the global window object of the remote application you've visited.
|
|
|
|
# Options
|
|
|
|
Pass in an options object to change the default behavior of `cy.window`.
|
|
|
|
**[cy.window( *options* )](#options-usage)**
|
|
|
|
Option | Default | Notes
|
|
--- | --- | ---
|
|
`log` | `true` | whether to display command in command log
|
|
|
|
# Usage
|
|
|
|
## Returns the remote window object
|
|
|
|
```javascript
|
|
cy
|
|
.visit("http://localhost:8080/app")
|
|
.window().then(function(win){
|
|
// win is the remote window
|
|
// of the page at: http://localhost:8080/app
|
|
})
|
|
```
|
|
|
|
# Options Usage
|
|
|
|
## Passes timeout through to `cy.should` assertion
|
|
|
|
```javascript
|
|
cy.window({timeout: 10000}).should("have.property", "foo")
|
|
```
|
|
|
|
# Command Log
|
|
|
|
## Get the window
|
|
|
|
```javascript
|
|
cy.window()
|
|
```
|
|
|
|
The commands above will display in the command log as:
|
|
|
|
<img width="587" alt="screen shot 2015-11-29 at 2 15 49 pm" src="https://cloud.githubusercontent.com/assets/1271364/11459397/ced0a6de-96a3-11e5-93b4-9abd9ffabd98.png">
|
|
|
|
When clicking on `window` within the command log, the console outputs the following:
|
|
|
|
<img width="758" alt="screen shot 2015-11-29 at 2 16 22 pm" src="https://cloud.githubusercontent.com/assets/1271364/11459398/d0e6f4be-96a3-11e5-8583-69dcffef9cd3.png">
|
|
|
|
# Related
|
|
|
|
- [visit](https://on.cypress.io/api/visit)
|
|
- [document](https://on.cypress.io/api/document)
|