Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cookie commands domain option description #4861

Merged
merged 1 commit into from
Nov 23, 2022
Merged

Update cookie commands domain option description #4861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/api/commands/clearcookie.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Pass in an options object to change the default behavior of `cy.clearCookie()`.

| Option | Default | Description |
| --------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `domain` | Superdomain of the current URL | Clears the cookie from the specified domain |
| `domain` | Hostname of the current URL | Clears the cookie from the specified domain |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `timeout` | [`responseTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `cy.clearCookie()` to resolve before [timing out](#Timeouts) |

Expand Down
2 changes: 1 addition & 1 deletion content/api/commands/clearcookies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Pass in an options object to change the default behavior of `cy.clearCookies()`.

| Option | Default | Description |
| --------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `domain` | Superdomain of the current URL | Clears the cookies from the specified domain |
| `domain` | Hostname of the current URL | Clears the cookies from the specified domain |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `timeout` | [`responseTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `cy.clearCookies()` to resolve before [timing out](#Timeouts) |

Expand Down
2 changes: 1 addition & 1 deletion content/api/commands/getcookie.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Pass in an options object to change the default behavior of `cy.getCookie()`.

| Option | Default | Description |
| --------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `domain` | Superdomain of the current URL | Retrieves the cookie from the specified domain |
| `domain` | Hostname of the current URL | Retrieves the cookie from the specified domain |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `timeout` | [`responseTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `cy.getCookie()` to resolve before [timing out](#Timeouts) |

Expand Down
2 changes: 1 addition & 1 deletion content/api/commands/getcookies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Pass in an options object to change the default behavior of `cy.getCookies()`.

| Option | Default | Description |
| --------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `domain` | Superdomain of the current URL | Retrieves the cookies from the specified domain |
| `domain` | Hostname of the current URL | Retrieves the cookies from the specified domain |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `timeout` | [`responseTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `cy.getCookies()` to resolve before [timing out](#Timeouts) |

Expand Down
2 changes: 1 addition & 1 deletion content/api/commands/setcookie.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Pass in an options object to change the default behavior of `cy.setCookie()`.
| Option | Default | Description |
| ---------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `domain` | Superdomain of the current URL | The domain the cookie is visible to |
| `domain` | Hostname of the current URL | The domain the cookie is visible to |
| `expiry` | 20 years into the future | When the cookie expires, specified in seconds since [Unix Epoch](https://en.wikipedia.org/wiki/Unix_time). |
| `httpOnly` | `false` | Whether the cookie is an HTTP only cookie |
| `path` | `/` | The cookie path |
Expand Down