Skip to content

feat: add setCookie documentation for hostOnly option #5071

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

Merged
merged 3 commits into from
Feb 17, 2023
Merged

feat: add setCookie documentation for hostOnly option #5071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
877454b
feat: add setCookie documentation for hostOnly option
AtofStryker Feb 16, 2023
7d9aa99
chore: add more detailed description for host only
AtofStryker Feb 16, 2023
cd02212
add hostOnly as return type in get cookie commands as an property if …
AtofStryker Feb 16, 2023
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
1 change: 1 addition & 0 deletions docs/api/commands/getallcookies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ the following properties:

- `domain`: _(String)_
- `expiry`: _(Number)_ _(if specified)_
- `hostOnly`: _(Boolean)_ _(if specified)_
- `httpOnly`: _(Boolean)_
- `name`: _(String)_
- `path`: _(String)_
Expand Down
1 change: 1 addition & 0 deletions docs/api/commands/getcookie.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Pass in an options object to change the default behavior of `cy.getCookie()`.

- `domain`
- `expiry` _(if specified)_
- `hostOnly` _(if specified)_
- `httpOnly`
- `name`
- `path`
Expand Down
1 change: 1 addition & 0 deletions docs/api/commands/getcookies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ following properties:

- `domain`: _(String)_
- `expiry`: _(Number)_ _(if specified)_
- `hostOnly`: _(Boolean)_ _(if specified)_
- `httpOnly`: _(Boolean)_
- `name`: _(String)_
- `path`: _(String)_
Expand Down
3 changes: 3 additions & 0 deletions docs/api/commands/setcookie.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Pass in an options object to change the default behavior of `cy.setCookie()`.
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `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). |
| `hostOnly` | `false` | Whether the cookie is a host-only cookie, (i.e. the request's host must exactly match the domain of the cookie) |
| `httpOnly` | `false` | Whether the cookie is an HTTP only cookie |
| `path` | `/` | The cookie path |
| `secure` | `false` | Whether the cookie is a secure cookie |
Expand All @@ -50,6 +51,7 @@ Pass in an options object to change the default behavior of `cy.setCookie()`.

- `domain`
- `expiry` _(if specified)_
- `hostOnly` _(if specified)_
- `httpOnly`
- `name`
- `path`
Expand Down Expand Up @@ -123,6 +125,7 @@ following:

| Version | Changes |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [12.6.0](/guides/references/changelog#12-6-0) | Support `hostOnly` option for a given domain. |
| [5.0.0](/guides/references/changelog#5-0-0) | Removed `experimentalGetCookiesSameSite` and made `sameSite` property always available. |
| [4.3.0](/guides/references/changelog#4-3-0) | Added `sameSite` property when the [experimentalGetCookiesSameSite](/guides/references/configuration#Experiments) configuration value is `true`. |
| [0.16.0](/guides/references/changelog#0-16-0) | `cy.setCookie()` command added |
Expand Down