microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-11-28 17:44:33 +03:00
Code Issues Projects Releases Wiki Activity

docs: improve addCookies.cookie parameter description (#31456)

Browse Source
This commit is contained in:
Yury Semikhatsky 2024-06-26 15:39:43 -07:00 committed by GitHub
parent 41b185d643
commit 111876d526
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/api/class-browsercontext.md
View File

@ -357,18 +357,14 @@ await context.AddCookiesAsync(new[] { cookie1, cookie2 });
- `cookies` <[Array]<[Object]>>
- `name` <[string]>
- `value` <[string]>
- `url` ?<[string]> either url or domain / path are required. Optional.
- `domain` ?<[string]> either url or domain / path are required Optional.
- `path` ?<[string]> either url or domain / path are required Optional.
- `url` ?<[string]> Either url or domain / path are required. Optional.
- `domain` ?<[string]> For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com". Either url or domain / path are required. Optional.
- `path` ?<[string]> Either url or domain / path are required Optional.
- `expires` ?<[float]> Unix time in seconds. Optional.
- `httpOnly` ?<[boolean]> Optional.
- `secure` ?<[boolean]> Optional.
- `sameSite` ?<[SameSiteAttribute]<"Strict"|"Lax"|"None">> Optional.
Adds cookies to the browser context.
For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com".
## async method: BrowserContext.addInitScript
* since: v1.8

11
packages/playwright-core/types/types.d.ts vendored
View File

@ -8286,9 +8286,7 @@ export interface BrowserContext {
* await browserContext.addCookies([cookieObject1, cookieObject2]);
* ```
*
* @param cookies Adds cookies to the browser context.
*
* For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com".
* @param cookies
*/
addCookies(cookies: ReadonlyArray<{
name: string;
@ -8296,17 +8294,18 @@ export interface BrowserContext {
value: string;
/**
* either url or domain / path are required. Optional.
* Either url or domain / path are required. Optional.
*/
url?: string;
/**
* either url or domain / path are required Optional.
* For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com". Either url
* or domain / path are required. Optional.
*/
domain?: string;
/**
* either url or domain / path are required Optional.
* Either url or domain / path are required Optional.
*/
path?: string;