Skip to content

docs: Update clearCookie documentation for Playwright helper #4005

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
Nov 20, 2023
Merged

docs: Update clearCookie documentation for Playwright helper #4005

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f28446a
Update documentation for Playwright clearCookie
Hellosager Nov 16, 2023
e0d1ab1
Remove space
Hellosager Nov 16, 2023
bdf05e6
fix: docs
kobenguyent Nov 20, 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
5 changes: 2 additions & 3 deletions docs/helpers/Playwright.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,12 +518,11 @@ I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })

### clearCookie

Clears a cookie by name,
if none provided clears all cookies.
Clears all cookies. Playwright currently doesn't support to delete a certain cookie.

```js
I.clearCookie();
I.clearCookie('test');
I.clearCookie('test'); // currently has the same effect as line above
```

#### Parameters
Expand Down
2 changes: 1 addition & 1 deletion lib/helper/Playwright.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1892,7 +1892,7 @@ class Playwright extends Helper {
*/
async clearCookie() {
// Playwright currently doesn't support to delete a certain cookie
// https://github.com/microsoft/playwright/blob/main/docs/api.md#class-browsercontext
// https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md
if (!this.browserContext) return;
return this.browserContext.clearCookies();
}
Expand Down