Chris Breiding
3.4 KiB
title: location comments: true
Get the remote window.location as a normalized object.
| Returns | location object detailed below |
| Timeout | cannot timeout |
cy.location()
Given a remote URL of http://localhost:8000/app/index.html?q=dan#/users/123/edit, an object would be returned with the following properties:
| Key | Type | Returns |
|---|---|---|
hash |
string | #/users/123/edit |
host |
string | localhost:8000 |
hostname |
string | localhost |
href |
string | http://localhost:8000/app/index.html?q=brian#/users/123/edit |
origin |
string | http://localhost:8000 |
pathname |
string | /app.index.html |
port |
string | 8000 |
protocol |
string | http: |
search |
string | ?q=brian |
toString |
function | http://localhost:8000/app/index.html?q=brian#/users/123/edit |
cy.location( key )
Get the specific value by key of the location object above.
Options
Pass in an options object to change the default behavior of cy.location.
cy.location( options ) cy.location( key, options )
| Option | Default | Notes |
|---|---|---|
log |
true |
whether to display command in command log |
Usage
Check location for query params and pathname
// we can yield the location subject and work with
// it directly as an object
cy
.get("#search").type("brian{enter}")
.location().should(function(location){
expect(location.search).to.eq("?search=brian")
expect(location.pathname).to.eq("/users")
expect(location.toString()).to.eq("http://localhost:8000/users?search=brian")
})
Key Usage
Assert that a redirect works
// we should be redirected to the login page
cy
.visit("http://localhost:3000/admin")
.location("pathname").should("eq", "/login")
Notes
Do not use window.location
Let's examine the following scenario:
// get our remote window and log out
// the window.location object
cy.window().then(function(window){
console.log(window.location)
})
// go through the location command
// and log out this object
cy.location().then(function(location){
console.log(location)
})
Cypress automatically normalizes the cy.location() command and strips out extrenuous values and properties found in window.location. Also the object literal returned by cy.location() is just a basic object literal, not the special window.location object.
When changing properties on the real window.location object, it will force the browser to navigate away. In Cypress, the object we returned is a plain object, and changing or affecting its properties will have no effect on navigation.
Command Log
Assert on the location's href
cy.location().should(function(location){
expect(location.href).to.include("commands/querying")
})
The commands above will display in the command log as:
When clicking on location within the command log, the console outputs the following:
