Skip to content

Commit 73663de

Browse files
authored
fix: relax grabCookie type (#3919)
1 parent 4c5e2cd commit 73663de

10 files changed

+38
-38
lines changed

Diff for: docs/helpers/Nightmare.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ assert(cookie.value, '123456');
487487
488488
- `name` **[string][3]?** cookie name.
489489
490-
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 }).`
490+
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 }).`
491491
492492
### grabCssPropertyFrom
493493

Diff for: docs/helpers/Playwright.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -982,7 +982,7 @@ assert(cookie.value, '123456');
982982

983983
- `name` **[string][8]?** cookie name.
984984

985-
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.
985+
Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
986986

987987
### grabCssPropertyFrom
988988

Diff for: docs/helpers/Protractor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@ assert(cookie.value, '123456');
648648
649649
- `name` **[string][9]?** cookie name.
650650
651-
Returns **([Promise][13]<[string][9]> | [Promise][13]<[Array][14]<[string][9]>>)** attribute valueReturns cookie in JSON [format][16].
651+
Returns **any** attribute valueReturns cookie in JSON [format][16].
652652
653653
### grabCssPropertyFrom
654654

Diff for: docs/helpers/Puppeteer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,7 @@ assert(cookie.value, '123456');
896896
897897
- `name` **[string][6]?** cookie name.
898898
899-
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.
899+
Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
900900
901901
### grabCssPropertyFrom
902902

Diff for: docs/helpers/TestCafe.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ assert(cookie.value, '123456');
520520

521521
- `name` **[string][4]?** cookie name.
522522

523-
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.
523+
Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
524524

525525
### grabCurrentUrl
526526

@@ -547,7 +547,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
547547

548548
- `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
549549

550-
Returns **[Promise][9]<[number][12]>** number of visible elements
550+
Returns **[Promise][9]<[number][11]>** number of visible elements
551551

552552
### grabPageScrollPosition
553553

@@ -601,7 +601,7 @@ let pins = await I.grabTextFromAll('#pin li');
601601

602602
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
603603

604-
Returns **[Promise][9]<[Array][11]<[string][4]>>** attribute value
604+
Returns **[Promise][9]<[Array][12]<[string][4]>>** attribute value
605605

606606
### grabValueFrom
607607

@@ -632,7 +632,7 @@ let inputs = await I.grabValueFromAll('//form/input');
632632

633633
- `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
634634

635-
Returns **[Promise][9]<[Array][11]<[string][4]>>** attribute value
635+
Returns **[Promise][9]<[Array][12]<[string][4]>>** attribute value
636636

637637
### moveCursorTo
638638

@@ -647,8 +647,8 @@ I.moveCursorTo('#submit', 5,5);
647647
#### Parameters
648648

649649
- `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
650-
- `offsetX` **[number][12]** (optional, `0` by default) X-axis offset.
651-
- `offsetY` **[number][12]** (optional, `0` by default) Y-axis offset.
650+
- `offsetX` **[number][11]** (optional, `0` by default) X-axis offset.
651+
- `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset.
652652
⚠️ returns a _promise_ which is synchronized internally by recorder
653653

654654
### pressKey
@@ -665,7 +665,7 @@ I.pressKey(['Control','a']);
665665

666666
#### Parameters
667667

668-
- `key` **([string][4] | [Array][11]<[string][4]>)** key or array of keys to press.
668+
- `key` **([string][4] | [Array][12]<[string][4]>)** key or array of keys to press.
669669
⚠️ returns a _promise_ which is synchronized internally by recorder
670670

671671

@@ -718,8 +718,8 @@ First parameter can be set to `maximize`.
718718

719719
#### Parameters
720720

721-
- `width` **[number][12]** width in pixels or `maximize`.
722-
- `height` **[number][12]** height in pixels.
721+
- `width` **[number][11]** width in pixels or `maximize`.
722+
- `height` **[number][11]** height in pixels.
723723
⚠️ returns a _promise_ which is synchronized internally by recorder
724724

725725
### rightClick
@@ -806,8 +806,8 @@ I.scrollTo('#submit', 5, 5);
806806
#### Parameters
807807

808808
- `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
809-
- `offsetX` **[number][12]** (optional, `0` by default) X-axis offset.
810-
- `offsetY` **[number][12]** (optional, `0` by default) Y-axis offset.
809+
- `offsetX` **[number][11]** (optional, `0` by default) X-axis offset.
810+
- `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset.
811811
⚠️ returns a _promise_ which is synchronized internally by recorder
812812

813813
### see
@@ -955,7 +955,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
955955
#### Parameters
956956

957957
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
958-
- `num` **[number][12]** number of elements.
958+
- `num` **[number][11]** number of elements.
959959
⚠️ returns a _promise_ which is synchronized internally by recorder
960960

961961
### seeTextEquals
@@ -995,7 +995,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
995995
#### Parameters
996996

997997
- `select` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
998-
- `option` **([string][4] | [Array][11]<any>)** visible text or value of option.
998+
- `option` **([string][4] | [Array][12]<any>)** visible text or value of option.
999999
⚠️ returns a _promise_ which is synchronized internally by recorder
10001000

10011001
### setCookie
@@ -1016,7 +1016,7 @@ I.setCookie([
10161016

10171017
#### Parameters
10181018

1019-
- `cookie` **(Cookie | [Array][11]<Cookie>)** a cookie object or array of cookie objects.
1019+
- `cookie` **(Cookie | [Array][12]<Cookie>)** a cookie object or array of cookie objects.
10201020
⚠️ returns a _promise_ which is synchronized internally by recorder
10211021

10221022
### switchTo
@@ -1082,7 +1082,7 @@ I.wait(2); // wait 2 secs
10821082

10831083
#### Parameters
10841084

1085-
- `sec` **[number][12]** number of second to wait.
1085+
- `sec` **[number][11]** number of second to wait.
10861086
⚠️ returns a _promise_ which is synchronized internally by recorder
10871087

10881088
### waitForElement
@@ -1098,7 +1098,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
10981098
#### Parameters
10991099

11001100
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
1101-
- `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait
1101+
- `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
11021102
⚠️ returns a _promise_ which is synchronized internally by recorder
11031103

11041104
### waitForFunction
@@ -1119,8 +1119,8 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
11191119
#### Parameters
11201120

11211121
- `fn` **([string][4] | [function][8])** to be executed in browser context.
1122-
- `argsOrSec` **([Array][11]<any> | [number][12])?** (optional, `1` by default) arguments for function or seconds.
1123-
- `sec` **[number][12]?** (optional, `1` by default) time in seconds to wait
1122+
- `argsOrSec` **([Array][12]<any> | [number][11])?** (optional, `1` by default) arguments for function or seconds.
1123+
- `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
11241124
⚠️ returns a _promise_ which is synchronized internally by recorder
11251125

11261126
### waitForInvisible
@@ -1135,7 +1135,7 @@ I.waitForInvisible('#popup');
11351135
#### Parameters
11361136

11371137
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
1138-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1138+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
11391139
⚠️ returns a _promise_ which is synchronized internally by recorder
11401140

11411141
### waitForText
@@ -1152,7 +1152,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
11521152
#### Parameters
11531153

11541154
- `text` **[string][4]** to wait for.
1155-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1155+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
11561156
- `context` **([string][4] | [object][5])?** (optional) element located by CSS|XPath|strict locator.
11571157
⚠️ returns a _promise_ which is synchronized internally by recorder
11581158

@@ -1168,7 +1168,7 @@ I.waitForVisible('#popup');
11681168
#### Parameters
11691169

11701170
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
1171-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1171+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
11721172
⚠️ returns a _promise_ which is synchronized internally by recorder
11731173

11741174
### waitInUrl
@@ -1182,7 +1182,7 @@ I.waitInUrl('/info', 2);
11821182
#### Parameters
11831183

11841184
- `urlPart` **[string][4]** value to check.
1185-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1185+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
11861186
⚠️ returns a _promise_ which is synchronized internally by recorder
11871187

11881188
### waitNumberOfVisibleElements
@@ -1196,8 +1196,8 @@ I.waitNumberOfVisibleElements('a', 3);
11961196
#### Parameters
11971197

11981198
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
1199-
- `num` **[number][12]** number of elements.
1200-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1199+
- `num` **[number][11]** number of elements.
1200+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
12011201
⚠️ returns a _promise_ which is synchronized internally by recorder
12021202

12031203
### waitToHide
@@ -1212,7 +1212,7 @@ I.waitToHide('#popup');
12121212
#### Parameters
12131213

12141214
- `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
1215-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1215+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
12161216
⚠️ returns a _promise_ which is synchronized internally by recorder
12171217

12181218
### waitUrlEquals
@@ -1227,7 +1227,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
12271227
#### Parameters
12281228

12291229
- `urlPart` **[string][4]** value to check.
1230-
- `sec` **[number][12]** (optional, `1` by default) time in seconds to wait
1230+
- `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
12311231
⚠️ returns a _promise_ which is synchronized internally by recorder
12321232

12331233
## getPageUrl
@@ -1258,9 +1258,9 @@ Client Functions
12581258

12591259
[10]: https://playwright.dev/docs/api/class-locator#locator-focus
12601260

1261-
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
1261+
[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
12621262

1263-
[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
1263+
[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
12641264

12651265
[13]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value
12661266

Diff for: docs/helpers/WebDriver.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1081,7 +1081,7 @@ assert(cookie.value, '123456');
10811081
10821082
- `name` **[string][17]?** cookie name.
10831083
1084-
Returns **([Promise][25]<[string][17]> | [Promise][25]<[Array][28]<[string][17]>>)** attribute value
1084+
Returns **any** attribute value
10851085
10861086
### grabCssPropertyFrom
10871087

Diff for: docs/webapi/grabCookie.mustache

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ assert(cookie.value, '123456');
88
```
99

1010
@param {?string} [name=null] cookie name.
11-
@returns {Promise<string>|Promise<string[]>} attribute value
11+
@returns {any} attribute value

Diff for: typings/tests/helpers/Playwright.types.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ playwright.seeNumberOfVisibleElements(str, num); // $ExpectType void
9595
playwright.setCookie({ name: str, value: str}); // $ExpectType void
9696
playwright.seeCookie(str); // $ExpectType void
9797
playwright.dontSeeCookie(str); // $ExpectType void
98-
playwright.grabCookie(); // $ExpectType Promise<string[]> | Promise<string>
98+
playwright.grabCookie(); // $ExpectType any
9999
playwright.clearCookie(); // $ExpectType void
100100
playwright.executeScript(() => {}); // $ExpectType Promise<any>
101101
playwright.grabTextFrom(str); // $ExpectType Promise<string>

Diff for: typings/tests/helpers/PlaywrightTs.types.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ playwright.seeNumberOfVisibleElements(str, num); // $ExpectType Promise<any>
9191
playwright.setCookie({ name: str, value: str}); // $ExpectType Promise<any>
9292
playwright.seeCookie(str); // $ExpectType Promise<any>
9393
playwright.dontSeeCookie(str); // $ExpectType Promise<any>
94-
playwright.grabCookie(); // $ExpectType Promise<string[]> | Promise<string>
94+
playwright.grabCookie(); // $ExpectType Promise<any>
9595
playwright.clearCookie(); // $ExpectType Promise<any>
9696
playwright.executeScript(() => {}); // $ExpectType Promise<any>
9797
playwright.grabTextFrom(str); // $ExpectType Promise<string>

Diff for: typings/tests/helpers/WebDriverIO.types.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -446,8 +446,8 @@ wd.grabCurrentUrl(); // $ExpectType Promise<string>
446446
wd.grabNumberOfVisibleElements(); // $ExpectError
447447
wd.grabNumberOfVisibleElements('div'); // $ExpectType Promise<number>
448448

449-
wd.grabCookie(); // $ExpectType Promise<string[]> | Promise<string>
450-
wd.grabCookie('name'); // $ExpectType Promise<string[]> | Promise<string>
449+
wd.grabCookie(); // $ExpectType any
450+
wd.grabCookie('name'); // $ExpectType any
451451

452452
wd.grabPopupText(); // $ExpectType Promise<string>
453453

0 commit comments

Comments
 (0)