Skip to content

Commit f78c027

Browse files
authored
fix: rename haveRequestHeaders of ppt and pw helpers (#3937)
* fix: rename haveRequestHeaders of ppt and pw helpers * Update Playwright.types.ts * Update PlaywrightTs.types.ts
1 parent bfe8d8f commit f78c027

File tree

6 files changed

+34
-34
lines changed

6 files changed

+34
-34
lines changed

docs/helpers/Playwright.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1377,20 +1377,6 @@ I.waitForFile('avatar.jpg', 5);
13771377

13781378
Returns **[Promise][9]<void>**
13791379

1380-
### haveRequestHeaders
1381-
1382-
Set headers for all next requests
1383-
1384-
```js
1385-
I.haveRequestHeaders({
1386-
'X-Sent-By': 'CodeceptJS',
1387-
});
1388-
```
1389-
1390-
#### Parameters
1391-
1392-
- `customHeaders` **[object][5]** headers to set
1393-
13941380
### makeApiRequest
13951381

13961382
Performs [api request][25] using
@@ -2077,6 +2063,20 @@ I.setCookie([
20772063

20782064
Returns **[Promise][9]<void>** automatically synchronized promise through #recorder
20792065

2066+
### setPlaywrightRequestHeaders
2067+
2068+
Set headers for all next requests
2069+
2070+
```js
2071+
I.setPlaywrightRequestHeaders({
2072+
'X-Sent-By': 'CodeceptJS',
2073+
});
2074+
```
2075+
2076+
#### Parameters
2077+
2078+
- `customHeaders` **[object][5]** headers to set
2079+
20802080
### startRecordingTraffic
20812081

20822082
Starts recording the network traffics.

docs/helpers/Puppeteer.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,20 +1227,6 @@ I.seeFile('avatar.jpg');
12271227
12281228
- `downloadPath` **[string][6]** change this parameter to set another directory for saving
12291229
1230-
### haveRequestHeaders
1231-
1232-
Set headers for all next requests
1233-
1234-
```js
1235-
I.haveRequestHeaders({
1236-
'X-Sent-By': 'CodeceptJS',
1237-
});
1238-
```
1239-
1240-
#### Parameters
1241-
1242-
- `customHeaders` **[object][4]** headers to set
1243-
12441230
### moveCursorTo
12451231
12461232
Moves cursor to element matched by locator.
@@ -1830,6 +1816,20 @@ I.setCookie([
18301816
18311817
Returns **[Promise][7]<void>** automatically synchronized promise through #recorder
18321818
1819+
### setPuppeteerRequestHeaders
1820+
1821+
Set headers for all next requests
1822+
1823+
```js
1824+
I.setPuppeteerRequestHeaders({
1825+
'X-Sent-By': 'CodeceptJS',
1826+
});
1827+
```
1828+
1829+
#### Parameters
1830+
1831+
- `customHeaders` **[object][4]** headers to set
1832+
18331833
### switchTo
18341834
18351835
Switches frame or in case of null locator reverts to parent.

lib/helper/Playwright.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -942,14 +942,14 @@ class Playwright extends Helper {
942942
* Set headers for all next requests
943943
*
944944
* ```js
945-
* I.haveRequestHeaders({
945+
* I.setPlaywrightRequestHeaders({
946946
* 'X-Sent-By': 'CodeceptJS',
947947
* });
948948
* ```
949949
*
950950
* @param {object} customHeaders headers to set
951951
*/
952-
async haveRequestHeaders(customHeaders) {
952+
async setPlaywrightRequestHeaders(customHeaders) {
953953
if (!customHeaders) {
954954
throw new Error('Cannot send empty headers.');
955955
}

lib/helper/Puppeteer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -682,14 +682,14 @@ class Puppeteer extends Helper {
682682
* Set headers for all next requests
683683
*
684684
* ```js
685-
* I.haveRequestHeaders({
685+
* I.setPuppeteerRequestHeaders({
686686
* 'X-Sent-By': 'CodeceptJS',
687687
* });
688688
* ```
689689
*
690690
* @param {object} customHeaders headers to set
691691
*/
692-
async haveRequestHeaders(customHeaders) {
692+
async setPuppeteerRequestHeaders(customHeaders) {
693693
if (!customHeaders) {
694694
throw new Error('Cannot send empty headers.');
695695
}

typings/tests/helpers/Playwright.types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ playwright._createContextPage(); // $ExpectType void
2222
playwright._createContextPage({}); // $ExpectType void
2323
playwright.amOnPage(str); // $ExpectType Promise<void>
2424
playwright.resizeWindow(num, num); // $ExpectType Promise<void>
25-
playwright.haveRequestHeaders(str); // $ExpectType void
25+
playwright.setPlaywrightRequestHeaders(str); // $ExpectType void
2626
playwright.moveCursorTo(str, num, num); // $ExpectType Promise<void>
2727
playwright.dragAndDrop(str); // $ExpectError
2828
playwright.dragAndDrop(str, str); // $ExpectType Promise<void>

typings/tests/helpers/PlaywrightTs.types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ playwright._getPageUrl(); // $ExpectType Promise<any>
2020
playwright.grabPopupText(); // $ExpectType Promise<string | null>
2121
playwright.amOnPage(str); // $ExpectType Promise<void>
2222
playwright.resizeWindow(num, num); // $ExpectType Promise<void>
23-
playwright.haveRequestHeaders(str); // $ExpectType Promise<any>
23+
playwright.setPlaywrightRequestHeaders(str); // $ExpectType Promise<any>
2424
playwright.moveCursorTo(str, num, num); // $ExpectType Promise<void>
2525
playwright.dragAndDrop(str); // $ExpectError
2626
playwright.dragAndDrop(str, str); // $ExpectType Promise<void>

0 commit comments

Comments
 (0)