Add missing fields to typescript definition for VisitOptions (#3991)

This commit is contained in:
Zach Bloomquist
2019-04-17 19:16:11 -04:00
committed by Brian Mann
parent 5f771936e3
commit 28f24b5997
+40
View File
@@ -2168,6 +2168,46 @@ declare namespace Cypress {
* @see https://on.cypress.io/visit
*/
interface VisitOptions extends Loggable, Timeoutable {
/**
* The URL to visit. Behaves the same as the `url` argument.
*/
url: string
/**
* The HTTP method to use in the visit. Can be `GET` or `POST`.
*
* @default "GET"
*/
method: 'GET' | 'POST'
/**
* An optional body to send along with a `POST` request. If it is a string, it will be passed along unmodified. If it is an object, it will be URL encoded to a string and sent with a `Content-Type: application/x-www-urlencoded` header.
*
* @example
* cy.visit({
* url: 'http://www.example.com/form.html',
* method: 'POST',
* body: {
* "field1": "foo",
* "field2": "bar"
* }
* })
*/
body: RequestBody
/**
* An object that maps HTTP header names to values to be sent along with the request.
*
* @example
* cy.visit({
* url: 'http://www.example.com',
* headers: {
* 'Accept-Language': 'en-US'
* }
* })
*/
headers: { [header: string]: string }
/**
* Called before your page has loaded all of its resources.
*