docs: Update clearCookie documentation for Playwright helper (#4005)

Author: Hellosager

docs/helpers/Nightmare.md

@@ -147,15 +147,13 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 #### Parameters
 
 -   `cookie` **[string][3]?** (optional, `null` by default) cookie name 
 
-Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

docs/helpers/Playwright.md

@@ -523,15 +523,13 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 #### Parameters
 
 -   `cookie` **[string][8]?** (optional, `null` by default) cookie name 
 
-Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .

docs/helpers/Protractor.md

@@ -267,15 +267,13 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 #### Parameters
 
 -   `cookie` **[string][9]?** (optional, `null` by default) cookie name 
 
-Returns **[Promise][10]<void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

docs/helpers/Puppeteer.md

@@ -396,16 +396,14 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 #### Parameters
 
 -   `name`  
 -   `cookie` **[string][6]?** (optional, `null` by default) cookie name 
 
-Returns **[Promise][7]<void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

docs/helpers/TestCafe.md

@@ -198,16 +198,14 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 #### Parameters
 
 -   `cookieName`  
 -   `cookie` **[string][4]?** (optional, `null` by default) cookie name 
 
-Returns **[Promise][5]<void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

docs/helpers/WebDriver.md

@@ -554,15 +554,13 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 #### Parameters
 
 -   `cookie` **[string][17]?** (optional, `null` by default) cookie name 
 
-Returns **[Promise][19]<void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

docs/webapi/clearCookie.mustache

@@ -3,8 +3,7 @@ if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test');
+I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
 ```
 
 @param {?string} [cookie=null] (optional, `null` by default) cookie name
-@returns {Promise<void>} automatically synchronized promise through #recorder

lib/helper/Playwright.js

@@ -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#async-method-browsercontextclearcookies
     if (!this.browserContext) return;
     return this.browserContext.clearCookies();
   }

typings/tests/helpers/Playwright.types.ts

@@ -96,7 +96,7 @@ playwright.setCookie({ name: str, value: str}); // $ExpectType Promise<void>
 playwright.seeCookie(str); // $ExpectType Promise<void>
 playwright.dontSeeCookie(str); // $ExpectType Promise<void>
 playwright.grabCookie(); // $ExpectType any
-playwright.clearCookie(); // $ExpectType Promise<void>
+playwright.clearCookie(); // $ExpectType void
 playwright.executeScript(() => {}); // $ExpectType Promise<any>
 playwright.grabTextFrom(str); // $ExpectType Promise<string>
 playwright.grabTextFromAll(str); // $ExpectType Promise<string[]>

typings/tests/helpers/PlaywrightTs.types.ts

@@ -92,7 +92,7 @@ playwright.setCookie({ name: str, value: str}); // $ExpectType Promise<void>
 playwright.seeCookie(str); // $ExpectType Promise<void>
 playwright.dontSeeCookie(str); // $ExpectType Promise<void>
 playwright.grabCookie(); // $ExpectType Promise<any>
-playwright.clearCookie(); // $ExpectType Promise<void>
+playwright.clearCookie(); // $ExpectType Promise<any>
 playwright.executeScript(() => {}); // $ExpectType Promise<any>
 playwright.grabTextFrom(str); // $ExpectType Promise<string>
 playwright.grabTextFromAll(str); // $ExpectType Promise<string[]>