diff --git a/docs/helpers/Nightmare.md b/docs/helpers/Nightmare.md index eadda7ef2..8791d1c71 100644 --- a/docs/helpers/Nightmare.md +++ b/docs/helpers/Nightmare.md @@ -487,7 +487,7 @@ assert(cookie.value, '123456'); - `name` **[string][3]?** cookie name. -Returns **([Promise][8]<[string][3]> | [Promise][8]<[Array][10]<[string][3]>>)** attribute valueCookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).` +Returns **any** attribute valueCookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).` ### grabCssPropertyFrom diff --git a/docs/helpers/Playwright.md b/docs/helpers/Playwright.md index b1f7ea5a1..b5e8082c6 100644 --- a/docs/helpers/Playwright.md +++ b/docs/helpers/Playwright.md @@ -982,7 +982,7 @@ assert(cookie.value, '123456'); - `name` **[string][8]?** cookie name. -Returns **([Promise][21]<[string][8]> | [Promise][21]<[Array][9]<[string][8]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain. +Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain. ### grabCssPropertyFrom diff --git a/docs/helpers/Protractor.md b/docs/helpers/Protractor.md index ec9736fa9..571daa5c1 100644 --- a/docs/helpers/Protractor.md +++ b/docs/helpers/Protractor.md @@ -648,7 +648,7 @@ assert(cookie.value, '123456'); - `name` **[string][9]?** cookie name. -Returns **([Promise][13]<[string][9]> | [Promise][13]<[Array][14]<[string][9]>>)** attribute valueReturns cookie in JSON [format][16]. +Returns **any** attribute valueReturns cookie in JSON [format][16]. ### grabCssPropertyFrom diff --git a/docs/helpers/Puppeteer.md b/docs/helpers/Puppeteer.md index 0dcc642ae..2fd5231fe 100644 --- a/docs/helpers/Puppeteer.md +++ b/docs/helpers/Puppeteer.md @@ -896,7 +896,7 @@ assert(cookie.value, '123456'); - `name` **[string][6]?** cookie name. -Returns **([Promise][13]<[string][6]> | [Promise][13]<[Array][15]<[string][6]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain. +Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain. ### grabCssPropertyFrom diff --git a/docs/helpers/TestCafe.md b/docs/helpers/TestCafe.md index 029918c21..b2a223502 100644 --- a/docs/helpers/TestCafe.md +++ b/docs/helpers/TestCafe.md @@ -520,7 +520,7 @@ assert(cookie.value, '123456'); - `name` **[string][4]?** cookie name. -Returns **([Promise][9]<[string][4]> | [Promise][9]<[Array][11]<[string][4]>>)** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain. +Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain. ### grabCurrentUrl @@ -547,7 +547,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p'); - `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator. -Returns **[Promise][9]<[number][12]>** number of visible elements +Returns **[Promise][9]<[number][11]>** number of visible elements ### grabPageScrollPosition @@ -601,7 +601,7 @@ let pins = await I.grabTextFromAll('#pin li'); - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -Returns **[Promise][9]<[Array][11]<[string][4]>>** attribute value +Returns **[Promise][9]<[Array][12]<[string][4]>>** attribute value ### grabValueFrom @@ -632,7 +632,7 @@ let inputs = await I.grabValueFromAll('//form/input'); - `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator. -Returns **[Promise][9]<[Array][11]<[string][4]>>** attribute value +Returns **[Promise][9]<[Array][12]<[string][4]>>** attribute value ### moveCursorTo @@ -647,8 +647,8 @@ I.moveCursorTo('#submit', 5,5); #### Parameters - `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator. -- `offsetX` **[number][12]** (optional, `0` by default) X-axis offset. -- `offsetY` **[number][12]** (optional, `0` by default) Y-axis offset. +- `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. +- `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. ⚠️ returns a _promise_ which is synchronized internally by recorder ### pressKey @@ -665,7 +665,7 @@ I.pressKey(['Control','a']); #### Parameters -- `key` **([string][4] | [Array][11]<[string][4]>)** key or array of keys to press. +- `key` **([string][4] | [Array][12]<[string][4]>)** key or array of keys to press. ⚠️ returns a _promise_ which is synchronized internally by recorder @@ -718,8 +718,8 @@ First parameter can be set to `maximize`. #### Parameters -- `width` **[number][12]** width in pixels or `maximize`. -- `height` **[number][12]** height in pixels. +- `width` **[number][11]** width in pixels or `maximize`. +- `height` **[number][11]** height in pixels. ⚠️ returns a _promise_ which is synchronized internally by recorder ### rightClick @@ -806,8 +806,8 @@ I.scrollTo('#submit', 5, 5); #### Parameters - `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator. -- `offsetX` **[number][12]** (optional, `0` by default) X-axis offset. -- `offsetY` **[number][12]** (optional, `0` by default) Y-axis offset. +- `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. +- `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. ⚠️ returns a _promise_ which is synchronized internally by recorder ### see @@ -955,7 +955,7 @@ I.seeNumberOfVisibleElements('.buttons', 3); #### Parameters - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -- `num` **[number][12]** number of elements. +- `num` **[number][11]** number of elements. ⚠️ returns a _promise_ which is synchronized internally by recorder ### seeTextEquals @@ -995,7 +995,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']); #### Parameters - `select` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator. -- `option` **([string][4] | [Array][11]<any>)** visible text or value of option. +- `option` **([string][4] | [Array][12]<any>)** visible text or value of option. ⚠️ returns a _promise_ which is synchronized internally by recorder ### setCookie @@ -1016,7 +1016,7 @@ I.setCookie([ #### Parameters -- `cookie` **(Cookie | [Array][11]<Cookie>)** a cookie object or array of cookie objects. +- `cookie` **(Cookie | [Array][12]<Cookie>)** a cookie object or array of cookie objects. ⚠️ returns a _promise_ which is synchronized internally by recorder ### switchTo @@ -1082,7 +1082,7 @@ I.wait(2); // wait 2 secs #### Parameters -- `sec` **[number][12]** number of second to wait. +- `sec` **[number][11]** number of second to wait. ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitForElement @@ -1098,7 +1098,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs #### Parameters - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -- `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitForFunction @@ -1119,8 +1119,8 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and #### Parameters - `fn` **([string][4] | [function][8])** to be executed in browser context. -- `argsOrSec` **([Array][11]<any> | [number][12])?** (optional, `1` by default) arguments for function or seconds. -- `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait +- `argsOrSec` **([Array][12]<any> | [number][11])?** (optional, `1` by default) arguments for function or seconds. +- `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitForInvisible @@ -1135,7 +1135,7 @@ I.waitForInvisible('#popup'); #### Parameters - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitForText @@ -1152,7 +1152,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal'); #### Parameters - `text` **[string][4]** to wait for. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait - `context` **([string][4] | [object][5])?** (optional) element located by CSS|XPath|strict locator. ⚠️ returns a _promise_ which is synchronized internally by recorder @@ -1168,7 +1168,7 @@ I.waitForVisible('#popup'); #### Parameters - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitInUrl @@ -1182,7 +1182,7 @@ I.waitInUrl('/info', 2); #### Parameters - `urlPart` **[string][4]** value to check. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitNumberOfVisibleElements @@ -1196,8 +1196,8 @@ I.waitNumberOfVisibleElements('a', 3); #### Parameters - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -- `num` **[number][12]** number of elements. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `num` **[number][11]** number of elements. +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitToHide @@ -1212,7 +1212,7 @@ I.waitToHide('#popup'); #### Parameters - `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ### waitUrlEquals @@ -1227,7 +1227,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info'); #### Parameters - `urlPart` **[string][4]** value to check. -- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait +- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait ⚠️ returns a _promise_ which is synchronized internally by recorder ## getPageUrl @@ -1258,9 +1258,9 @@ Client Functions [10]: https://playwright.dev/docs/api/class-locator#locator-focus -[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array +[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number -[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number +[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array [13]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value diff --git a/docs/helpers/WebDriver.md b/docs/helpers/WebDriver.md index e36f9fa48..4e82f84ff 100644 --- a/docs/helpers/WebDriver.md +++ b/docs/helpers/WebDriver.md @@ -1081,7 +1081,7 @@ assert(cookie.value, '123456'); - `name` **[string][17]?** cookie name. -Returns **([Promise][25]<[string][17]> | [Promise][25]<[Array][28]<[string][17]>>)** attribute value +Returns **any** attribute value ### grabCssPropertyFrom diff --git a/docs/webapi/grabCookie.mustache b/docs/webapi/grabCookie.mustache index 730e609bd..3a40652ce 100644 --- a/docs/webapi/grabCookie.mustache +++ b/docs/webapi/grabCookie.mustache @@ -8,4 +8,4 @@ assert(cookie.value, '123456'); ``` @param {?string} [name=null] cookie name. -@returns {Promise|Promise} attribute value +@returns {any} attribute value diff --git a/typings/tests/helpers/Playwright.types.ts b/typings/tests/helpers/Playwright.types.ts index 014640ceb..d0b8ce372 100644 --- a/typings/tests/helpers/Playwright.types.ts +++ b/typings/tests/helpers/Playwright.types.ts @@ -95,7 +95,7 @@ playwright.seeNumberOfVisibleElements(str, num); // $ExpectType void playwright.setCookie({ name: str, value: str}); // $ExpectType void playwright.seeCookie(str); // $ExpectType void playwright.dontSeeCookie(str); // $ExpectType void -playwright.grabCookie(); // $ExpectType Promise | Promise +playwright.grabCookie(); // $ExpectType any playwright.clearCookie(); // $ExpectType void playwright.executeScript(() => {}); // $ExpectType Promise playwright.grabTextFrom(str); // $ExpectType Promise diff --git a/typings/tests/helpers/PlaywrightTs.types.ts b/typings/tests/helpers/PlaywrightTs.types.ts index afa434b6f..1d936ec56 100644 --- a/typings/tests/helpers/PlaywrightTs.types.ts +++ b/typings/tests/helpers/PlaywrightTs.types.ts @@ -91,7 +91,7 @@ playwright.seeNumberOfVisibleElements(str, num); // $ExpectType Promise playwright.setCookie({ name: str, value: str}); // $ExpectType Promise playwright.seeCookie(str); // $ExpectType Promise playwright.dontSeeCookie(str); // $ExpectType Promise -playwright.grabCookie(); // $ExpectType Promise | Promise +playwright.grabCookie(); // $ExpectType Promise playwright.clearCookie(); // $ExpectType Promise playwright.executeScript(() => {}); // $ExpectType Promise playwright.grabTextFrom(str); // $ExpectType Promise diff --git a/typings/tests/helpers/WebDriverIO.types.ts b/typings/tests/helpers/WebDriverIO.types.ts index 6614374bb..2e44a62ae 100644 --- a/typings/tests/helpers/WebDriverIO.types.ts +++ b/typings/tests/helpers/WebDriverIO.types.ts @@ -446,8 +446,8 @@ wd.grabCurrentUrl(); // $ExpectType Promise wd.grabNumberOfVisibleElements(); // $ExpectError wd.grabNumberOfVisibleElements('div'); // $ExpectType Promise -wd.grabCookie(); // $ExpectType Promise | Promise -wd.grabCookie('name'); // $ExpectType Promise | Promise +wd.grabCookie(); // $ExpectType any +wd.grabCookie('name'); // $ExpectType any wd.grabPopupText(); // $ExpectType Promise