Skip to content

Commit

Permalink
Add example for location.href - also should example (#4702)
Browse files Browse the repository at this point in the history
  • Loading branch information
jennifer-shehane authored and flotwig committed Jul 12, 2019
1 parent fbd5236 commit 5963b1e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions cli/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,8 @@ declare namespace Cypress {
* @example
* cy.location('host') // Get the host of the location object
* cy.location('port') // Get the port of the location object
* // Assert on the href of the location
* cy.location('href').should('contain', '/tag/tutorials')
*/
location(key: string, options?: Partial<Loggable & Timeoutable>): Chainable<Location>

Expand Down Expand Up @@ -1276,6 +1278,9 @@ declare namespace Cypress {
* Create an assertion. Assertions are automatically retried until they pass or time out.
*
* @see https://on.cypress.io/should
* @example
* // Assert on the href of the location
* cy.location('href').should('contain', '/tag/tutorials/')
*/
should: Chainer<Subject>

Expand Down

2 comments on commit 5963b1e

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 5963b1e Jul 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the linux x64 version of the Test Runner.

You can install this pre-release platform-specific build using instructions at https://on.cypress.io/installing-cypress#Install-pre-release-version.

You will need to use custom CYPRESS_INSTALL_BINARY url and install Cypress using an url instead of the version.

export CYPRESS_INSTALL_BINARY=https://cdn.cypress.io/beta/binary/3.4.1/linux-x64/circle-develop-5963b1eff8551c9e14ae03498b3eefda63b4e492-133017/cypress.zip
npm install https://cdn.cypress.io/beta/npm/3.4.1/circle-develop-5963b1eff8551c9e14ae03498b3eefda63b4e492-133027/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 5963b1e Jul 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the darwin x64 version of the Test Runner.

You can install this pre-release platform-specific build using instructions at https://on.cypress.io/installing-cypress#Install-pre-release-version.

You will need to use custom CYPRESS_INSTALL_BINARY url and install Cypress using an url instead of the version.

export CYPRESS_INSTALL_BINARY=https://cdn.cypress.io/beta/binary/3.4.1/darwin-x64/circle-develop-5963b1eff8551c9e14ae03498b3eefda63b4e492-133049/cypress.zip
npm install https://cdn.cypress.io/beta/npm/3.4.1/circle-develop-5963b1eff8551c9e14ae03498b3eefda63b4e492-133048/cypress.tgz

Please sign in to comment.