fix: docs

codeceptjs · Nov 20, 2023 · bdf05e6 · bdf05e6
1 parent e0d1ab1
commit bdf05e6
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 26 deletions.
diff --git a/docs/helpers/Nightmare.md b/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]&lt;void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

diff --git a/docs/helpers/Playwright.md b/docs/helpers/Playwright.md
@@ -518,19 +518,18 @@ I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
 
 ### clearCookie
 
-Clears all cookies. Playwright currently doesn't support to delete a certain cookie.
+Clears a cookie by name,
+if none provided clears all cookies.
 
 ```js
 I.clearCookie();
-I.clearCookie('test'); // currently has the same effect as line above
+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]&lt;void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .

diff --git a/docs/helpers/Protractor.md b/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]&lt;void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

diff --git a/docs/helpers/Puppeteer.md b/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]&lt;void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

diff --git a/docs/helpers/TestCafe.md b/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]&lt;void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

diff --git a/docs/helpers/WebDriver.md b/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]&lt;void>** automatically synchronized promise through #recorder
-
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.

diff --git a/docs/webapi/clearCookie.mustache b/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
diff --git a/lib/helper/Playwright.js b/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/src/api/class-browsercontext.md
+    // https://github.com/microsoft/playwright/blob/main/docs/src/api/class-browsercontext.md#async-method-browsercontextclearcookies
     if (!this.browserContext) return;
     return this.browserContext.clearCookies();
   }

diff --git a/typings/tests/helpers/Playwright.types.ts b/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[]>

diff --git a/typings/tests/helpers/PlaywrightTs.types.ts b/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[]>

diff --git a/typings/tests/helpers/WebDriverIO.types.ts b/typings/tests/helpers/WebDriverIO.types.ts
@@ -272,8 +272,8 @@ wd.setCookie(); // $ExpectError
 wd.setCookie({ name: str, value: str }); // $ExpectType Promise<void>
 wd.setCookie([{ name: str, value: str }]); // $ExpectType Promise<void>
 
-wd.clearCookie(); // $ExpectType Promise<void>
-wd.clearCookie(str); // $ExpectType Promise<void>
+wd.clearCookie(); // $ExpectType void
+wd.clearCookie(str); // $ExpectType void
 
 wd.seeCookie(); // $ExpectError
 wd.seeCookie(str); // $ExpectType Promise<void>