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

microsoft · Jun 26, 2024 · 111876d · 111876d
1 parent 41b185d
commit 111876d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 13 deletions.
diff --git a/docs/src/api/class-browsercontext.md b/docs/src/api/class-browsercontext.md
@@ -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
 

diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
@@ -8286,27 +8286,26 @@ 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;
 
     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;