From c5516a74679d41b30ac35a1e50ce0b5e92aa9911 Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Wed, 26 Jun 2024 14:58:36 -0700 Subject: [PATCH] docs: improve addCookies.cookie parameter description --- docs/src/api/class-browsercontext.md | 6 +----- packages/playwright-core/types/types.d.ts | 7 +++---- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/docs/src/api/class-browsercontext.md b/docs/src/api/class-browsercontext.md index 686db16f4a..1fe958972c 100644 --- a/docs/src/api/class-browsercontext.md +++ b/docs/src/api/class-browsercontext.md @@ -358,17 +358,13 @@ await context.AddCookiesAsync(new[] { cookie1, cookie2 }); - `name` <[string]> - `value` <[string]> - `url` ?<[string]> either url or domain / path are required. Optional. - - `domain` ?<[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 diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts index 00b20c80c9..541a31a446 100644 --- a/packages/playwright-core/types/types.d.ts +++ b/packages/playwright-core/types/types.d.ts @@ -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; @@ -8301,7 +8299,8 @@ export interface BrowserContext { 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;