codeceptjs 4.2.3 → 4.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/element-selection.md +27 -4
- package/docs/helpers/Appium.md +54 -54
- package/docs/helpers/Kitesurf.md +64 -64
- package/docs/helpers/Lightpanda.md +64 -64
- package/docs/helpers/Moli.md +64 -64
- package/docs/helpers/Obscura.md +64 -64
- package/docs/helpers/Playwright.md +125 -125
- package/docs/helpers/Puppeteer.md +85 -85
- package/docs/helpers/WebDriver.md +86 -86
- package/docs/locators.md +5 -7
- package/docs/migration-4.md +7 -3
- package/docs/retry.md +1 -1
- package/docs/timeouts.md +2 -2
- package/lib/actor.js +20 -2
- package/lib/data/context.js +24 -0
- package/lib/element/WebElement.js +5 -5
- package/lib/helper/Appium.js +1 -1
- package/lib/helper/Playwright.js +21 -11
- package/lib/helper/Puppeteer.js +2 -8
- package/lib/recorder.js +2 -1
- package/lib/step/base.js +8 -1
- package/lib/step/record.js +22 -17
- package/lib/step/retry.js +13 -6
- package/lib/utils/typescript.js +86 -12
- package/package.json +2 -1
- package/typings/index.d.ts +12 -0
- package/typings/promiseBasedTypes.d.ts +690 -345
- package/typings/types.d.ts +479 -346
|
@@ -335,7 +335,7 @@ I.amOnPage('/login'); // opens a login page
|
|
|
335
335
|
|
|
336
336
|
* `url` **[string][7]** url path or global url.
|
|
337
337
|
|
|
338
|
-
Returns **
|
|
338
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
339
339
|
|
|
340
340
|
### appendField
|
|
341
341
|
|
|
@@ -358,7 +358,7 @@ I.appendField('name', 'John', '.form-container');
|
|
|
358
358
|
* `value` **[string][7]** text value to append.
|
|
359
359
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
360
360
|
|
|
361
|
-
Returns **
|
|
361
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
362
362
|
|
|
363
363
|
### attachFile
|
|
364
364
|
|
|
@@ -388,7 +388,7 @@ I.attachFile('#dropzone', 'data/avatar.jpg');
|
|
|
388
388
|
* `pathToFile` **[string][7]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
|
|
389
389
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
390
390
|
|
|
391
|
-
Returns **
|
|
391
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
392
392
|
|
|
393
393
|
### blockTraffic
|
|
394
394
|
|
|
@@ -434,7 +434,7 @@ I.dontSee('#add-to-cart-btn');
|
|
|
434
434
|
* `locator` **([string][7] | [object][8])** field located by label|name|CSS|XPath|strict locator.
|
|
435
435
|
* `options` **any?** Playwright only: [Additional options][13] for available options object as 2nd argument.
|
|
436
436
|
|
|
437
|
-
Returns **
|
|
437
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
438
438
|
|
|
439
439
|
### cancelPopup
|
|
440
440
|
|
|
@@ -474,7 +474,7 @@ I.checkOption('agree', '//form');
|
|
|
474
474
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
475
475
|
* `options`
|
|
476
476
|
|
|
477
|
-
Returns **
|
|
477
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
478
478
|
|
|
479
479
|
### clearClipboard
|
|
480
480
|
|
|
@@ -485,7 +485,7 @@ I.clearClipboard();
|
|
|
485
485
|
I.seeClipboardEquals('');
|
|
486
486
|
```
|
|
487
487
|
|
|
488
|
-
Returns **
|
|
488
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
489
489
|
|
|
490
490
|
### clearCookie
|
|
491
491
|
|
|
@@ -522,7 +522,7 @@ I.clearField('Email', '.form-container');
|
|
|
522
522
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
523
523
|
* `editable` **([string][7] | [object][8])** field located by label|name|CSS|XPath|strict locator.
|
|
524
524
|
|
|
525
|
-
Returns **
|
|
525
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder.
|
|
526
526
|
|
|
527
527
|
### click
|
|
528
528
|
|
|
@@ -574,7 +574,7 @@ I.click('.edit', null, { modifiers: ['Ctrl'] } )
|
|
|
574
574
|
```
|
|
575
575
|
````
|
|
576
576
|
|
|
577
|
-
Returns **
|
|
577
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
578
578
|
|
|
579
579
|
### clickXY
|
|
580
580
|
|
|
@@ -596,7 +596,7 @@ I.clickXY('#someElement', 50, 30);
|
|
|
596
596
|
* `x` **[number][17]?** X coordinate relative to element, or Y coordinate if locator is a number.
|
|
597
597
|
* `y` **[number][17]?** Y coordinate relative to element.
|
|
598
598
|
|
|
599
|
-
Returns **
|
|
599
|
+
Returns **CodeceptJS.ElementStepPromise** 
|
|
600
600
|
|
|
601
601
|
### closeCurrentTab
|
|
602
602
|
|
|
@@ -629,7 +629,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
|
|
|
629
629
|
* `text` **[string][7]** which is not present.
|
|
630
630
|
* `context` **([string][7] | [object][8])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
631
631
|
|
|
632
|
-
Returns **
|
|
632
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
633
633
|
|
|
634
634
|
### dontSeeCheckboxIsChecked
|
|
635
635
|
|
|
@@ -645,7 +645,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
|
|
|
645
645
|
|
|
646
646
|
* `field` **([string][7] | [object][8])** located by label|name|CSS|XPath|strict locator.
|
|
647
647
|
|
|
648
|
-
Returns **
|
|
648
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
649
649
|
|
|
650
650
|
### dontSeeCookie
|
|
651
651
|
|
|
@@ -659,7 +659,7 @@ I.dontSeeCookie('auth'); // no auth cookie
|
|
|
659
659
|
|
|
660
660
|
* `name` **[string][7]** cookie name.
|
|
661
661
|
|
|
662
|
-
Returns **
|
|
662
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
663
663
|
|
|
664
664
|
### dontSeeCurrentPathEquals
|
|
665
665
|
|
|
@@ -675,7 +675,7 @@ I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
|
|
|
675
675
|
|
|
676
676
|
* `path` **[string][7]** value to check.
|
|
677
677
|
|
|
678
|
-
Returns **
|
|
678
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
679
679
|
|
|
680
680
|
### dontSeeCurrentUrlEquals
|
|
681
681
|
|
|
@@ -691,7 +691,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
|
|
|
691
691
|
|
|
692
692
|
* `url` **[string][7]** value to check.
|
|
693
693
|
|
|
694
|
-
Returns **
|
|
694
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
695
695
|
|
|
696
696
|
### dontSeeElement
|
|
697
697
|
|
|
@@ -709,7 +709,7 @@ I.dontSeeElement('.modal', '#container');
|
|
|
709
709
|
* `locator` **([string][7] | [object][8])** located by CSS|XPath|Strict locator.
|
|
710
710
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
711
711
|
|
|
712
|
-
Returns **
|
|
712
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
713
713
|
|
|
714
714
|
### dontSeeElementInDOM
|
|
715
715
|
|
|
@@ -723,7 +723,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
|
|
|
723
723
|
|
|
724
724
|
* `locator` **([string][7] | [object][8])** located by CSS|XPath|Strict locator.
|
|
725
725
|
|
|
726
|
-
Returns **
|
|
726
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
727
727
|
|
|
728
728
|
### dontSeeInCurrentUrl
|
|
729
729
|
|
|
@@ -733,7 +733,7 @@ Checks that current url does not contain a provided fragment.
|
|
|
733
733
|
|
|
734
734
|
* `url` **[string][7]** value to check.
|
|
735
735
|
|
|
736
|
-
Returns **
|
|
736
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
737
737
|
|
|
738
738
|
### dontSeeInField
|
|
739
739
|
|
|
@@ -755,7 +755,7 @@ I.dontSeeInField('Name', 'old_value', '.form-container');
|
|
|
755
755
|
* `value` **([string][7] | [object][8])** value to check.
|
|
756
756
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
757
757
|
|
|
758
|
-
Returns **
|
|
758
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
759
759
|
|
|
760
760
|
### dontSeeInSource
|
|
761
761
|
|
|
@@ -770,7 +770,7 @@ I.dontSeeInSource('<!--'); // no comments in source
|
|
|
770
770
|
* `text`  
|
|
771
771
|
* `value` **[string][7]** to check.
|
|
772
772
|
|
|
773
|
-
Returns **
|
|
773
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
774
774
|
|
|
775
775
|
### dontSeeInTitle
|
|
776
776
|
|
|
@@ -784,7 +784,7 @@ I.dontSeeInTitle('Error');
|
|
|
784
784
|
|
|
785
785
|
* `text` **[string][7]** value to check.
|
|
786
786
|
|
|
787
|
-
Returns **
|
|
787
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
788
788
|
|
|
789
789
|
### dontSeeTraffic
|
|
790
790
|
|
|
@@ -823,7 +823,7 @@ I.doubleClick('.btn.edit');
|
|
|
823
823
|
* `locator` **([string][7] | [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
824
824
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
825
825
|
|
|
826
|
-
Returns **
|
|
826
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
827
827
|
|
|
828
828
|
### dragAndDrop
|
|
829
829
|
|
|
@@ -844,9 +844,9 @@ I.dragAndDrop('#dragHandle', '#container');
|
|
|
844
844
|
|
|
845
845
|
* `srcElement` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
846
846
|
* `destElement` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
847
|
-
* `options` **any?** [Additional options][
|
|
847
|
+
* `options` **any?** [Additional options][18] can be passed as 3rd argument.
|
|
848
848
|
|
|
849
|
-
Returns **
|
|
849
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
850
850
|
|
|
851
851
|
### dragSlider
|
|
852
852
|
|
|
@@ -863,7 +863,7 @@ I.dragSlider('#slider', -70);
|
|
|
863
863
|
* `locator` **([string][7] | [object][8])** located by label|name|CSS|XPath|strict locator.
|
|
864
864
|
* `offsetX` **[number][17]** position to drag.
|
|
865
865
|
|
|
866
|
-
Returns **
|
|
866
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
867
867
|
|
|
868
868
|
### executeScript
|
|
869
869
|
|
|
@@ -890,10 +890,10 @@ If a function returns a Promise it will wait for its resolution.
|
|
|
890
890
|
|
|
891
891
|
#### Parameters
|
|
892
892
|
|
|
893
|
-
* `fn` **([string][7] | [function][
|
|
893
|
+
* `fn` **([string][7] | [function][19])** function to be executed in browser context.
|
|
894
894
|
* `arg` **any?** optional argument to pass to the function
|
|
895
895
|
|
|
896
|
-
Returns **[Promise][
|
|
896
|
+
Returns **[Promise][20]<any>** 
|
|
897
897
|
|
|
898
898
|
### fillField
|
|
899
899
|
|
|
@@ -925,7 +925,7 @@ I.fillField('Name', 'John', '#section2');
|
|
|
925
925
|
* `value` **([string][7] | [object][8])** text value to fill.
|
|
926
926
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
927
927
|
|
|
928
|
-
Returns **
|
|
928
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
929
929
|
|
|
930
930
|
### flushNetworkTraffics
|
|
931
931
|
|
|
@@ -956,7 +956,7 @@ I.see('#add-to-cart-bnt');
|
|
|
956
956
|
* `locator` **([string][7] | [object][8])** field located by label|name|CSS|XPath|strict locator.
|
|
957
957
|
* `options` **any?** Playwright only: [Additional options][21] for available options object as 2nd argument.
|
|
958
958
|
|
|
959
|
-
Returns **
|
|
959
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
960
960
|
|
|
961
961
|
### forceClick
|
|
962
962
|
|
|
@@ -990,7 +990,7 @@ I.forceClick({css: 'nav a.login'});
|
|
|
990
990
|
* `locator` **([string][7] | [object][8])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
991
991
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
992
992
|
|
|
993
|
-
Returns **
|
|
993
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
994
994
|
|
|
995
995
|
### grabAriaSnapshot
|
|
996
996
|
|
|
@@ -1012,7 +1012,7 @@ expect(formSnapshot).toContain('textbox "Email"');
|
|
|
1012
1012
|
|
|
1013
1013
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator. Defaults to body element.
|
|
1014
1014
|
|
|
1015
|
-
Returns **[Promise][
|
|
1015
|
+
Returns **[Promise][20]<[string][7]>** YAML representation of the accessibility tree
|
|
1016
1016
|
|
|
1017
1017
|
### grabAttributeFrom
|
|
1018
1018
|
|
|
@@ -1029,7 +1029,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
|
|
|
1029
1029
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1030
1030
|
* `attr` **[string][7]** attribute name.
|
|
1031
1031
|
|
|
1032
|
-
Returns **[Promise][
|
|
1032
|
+
Returns **[Promise][20]<[string][7]>** attribute value
|
|
1033
1033
|
|
|
1034
1034
|
### grabAttributeFromAll
|
|
1035
1035
|
|
|
@@ -1045,7 +1045,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
|
|
|
1045
1045
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1046
1046
|
* `attr` **[string][7]** attribute name.
|
|
1047
1047
|
|
|
1048
|
-
Returns **[Promise][
|
|
1048
|
+
Returns **[Promise][20]<[Array][9]<[string][7]>>** attribute value
|
|
1049
1049
|
|
|
1050
1050
|
### grabBrowserLogs
|
|
1051
1051
|
|
|
@@ -1059,7 +1059,7 @@ console.log(JSON.stringify(errors));
|
|
|
1059
1059
|
|
|
1060
1060
|
[Learn more about console messages][24]
|
|
1061
1061
|
|
|
1062
|
-
Returns **[Promise][
|
|
1062
|
+
Returns **[Promise][20]<[Array][9]<any>>** 
|
|
1063
1063
|
|
|
1064
1064
|
### grabCheckedElementStatus
|
|
1065
1065
|
|
|
@@ -1070,7 +1070,7 @@ Return the checked status of given element.
|
|
|
1070
1070
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1071
1071
|
* `options` **[object][8]?** See [https://playwright.dev/docs/api/class-locator#locator-is-checked][25]
|
|
1072
1072
|
|
|
1073
|
-
Returns **[Promise][
|
|
1073
|
+
Returns **[Promise][20]<[boolean][26]>** 
|
|
1074
1074
|
|
|
1075
1075
|
### grabCookie
|
|
1076
1076
|
|
|
@@ -1106,7 +1106,7 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
|
|
|
1106
1106
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1107
1107
|
* `cssProperty` **[string][7]** CSS property name.
|
|
1108
1108
|
|
|
1109
|
-
Returns **[Promise][
|
|
1109
|
+
Returns **[Promise][20]<[string][7]>** CSS value
|
|
1110
1110
|
|
|
1111
1111
|
### grabCssPropertyFromAll
|
|
1112
1112
|
|
|
@@ -1122,7 +1122,7 @@ const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
|
|
|
1122
1122
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1123
1123
|
* `cssProperty` **[string][7]** CSS property name.
|
|
1124
1124
|
|
|
1125
|
-
Returns **[Promise][
|
|
1125
|
+
Returns **[Promise][20]<[Array][9]<[string][7]>>** CSS value
|
|
1126
1126
|
|
|
1127
1127
|
### grabCurrentUrl
|
|
1128
1128
|
|
|
@@ -1134,7 +1134,7 @@ let url = await I.grabCurrentUrl();
|
|
|
1134
1134
|
console.log(`Current URL is [${url}]`);
|
|
1135
1135
|
```
|
|
1136
1136
|
|
|
1137
|
-
Returns **[Promise][
|
|
1137
|
+
Returns **[Promise][20]<[string][7]>** current URL
|
|
1138
1138
|
|
|
1139
1139
|
### grabDataFromPerformanceTiming
|
|
1140
1140
|
|
|
@@ -1159,7 +1159,7 @@ let data = await I.grabDataFromPerformanceTiming();
|
|
|
1159
1159
|
}
|
|
1160
1160
|
```
|
|
1161
1161
|
|
|
1162
|
-
Returns **
|
|
1162
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1163
1163
|
|
|
1164
1164
|
### grabDisabledElementStatus
|
|
1165
1165
|
|
|
@@ -1170,7 +1170,7 @@ Return the disabled status of given element.
|
|
|
1170
1170
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1171
1171
|
* `options` **[object][8]?** See [https://playwright.dev/docs/api/class-locator#locator-is-disabled][27]
|
|
1172
1172
|
|
|
1173
|
-
Returns **[Promise][
|
|
1173
|
+
Returns **[Promise][20]<[boolean][26]>** 
|
|
1174
1174
|
|
|
1175
1175
|
### grabElementBoundingRect
|
|
1176
1176
|
|
|
@@ -1198,7 +1198,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
|
|
|
1198
1198
|
* `prop`  
|
|
1199
1199
|
* `elementSize` **[string][7]?** x, y, width or height of the given element.
|
|
1200
1200
|
|
|
1201
|
-
Returns **([Promise][
|
|
1201
|
+
Returns **([Promise][20]<DOMRect> | [Promise][20]<[number][17]>)** Element bounding rectangle
|
|
1202
1202
|
|
|
1203
1203
|
### grabFromClipboard
|
|
1204
1204
|
|
|
@@ -1213,7 +1213,7 @@ let url = await I.grabFromClipboard();
|
|
|
1213
1213
|
Reading the clipboard requires a secure context (`https` or `localhost`) and is supported
|
|
1214
1214
|
in Chromium-based browsers, where read access is granted automatically.
|
|
1215
1215
|
|
|
1216
|
-
Returns **[Promise][
|
|
1216
|
+
Returns **[Promise][20]<[string][7]>** the system clipboard contents.
|
|
1217
1217
|
|
|
1218
1218
|
### grabHTMLFrom
|
|
1219
1219
|
|
|
@@ -1230,7 +1230,7 @@ let postHTML = await I.grabHTMLFrom('#post');
|
|
|
1230
1230
|
* `locator`  
|
|
1231
1231
|
* `element` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
1232
1232
|
|
|
1233
|
-
Returns **[Promise][
|
|
1233
|
+
Returns **[Promise][20]<[string][7]>** HTML code for an element
|
|
1234
1234
|
|
|
1235
1235
|
### grabHTMLFromAll
|
|
1236
1236
|
|
|
@@ -1246,7 +1246,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
|
|
|
1246
1246
|
* `locator`  
|
|
1247
1247
|
* `element` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
1248
1248
|
|
|
1249
|
-
Returns **[Promise][
|
|
1249
|
+
Returns **[Promise][20]<[Array][9]<[string][7]>>** HTML code for an element
|
|
1250
1250
|
|
|
1251
1251
|
### grabMetrics
|
|
1252
1252
|
|
|
@@ -1301,7 +1301,7 @@ const metrics = await I.grabMetrics();
|
|
|
1301
1301
|
|
|
1302
1302
|
```
|
|
1303
1303
|
|
|
1304
|
-
Returns **[Promise][
|
|
1304
|
+
Returns **[Promise][20]<[Array][9]<[Object][8]>>** 
|
|
1305
1305
|
|
|
1306
1306
|
### grabNumberOfOpenTabs
|
|
1307
1307
|
|
|
@@ -1312,7 +1312,7 @@ Resumes test execution, so **should be used inside async function with `await`**
|
|
|
1312
1312
|
let tabs = await I.grabNumberOfOpenTabs();
|
|
1313
1313
|
```
|
|
1314
1314
|
|
|
1315
|
-
Returns **[Promise][
|
|
1315
|
+
Returns **[Promise][20]<[number][17]>** number of open tabs
|
|
1316
1316
|
|
|
1317
1317
|
### grabNumberOfVisibleElements
|
|
1318
1318
|
|
|
@@ -1327,7 +1327,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
|
|
|
1327
1327
|
|
|
1328
1328
|
* `locator` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
1329
1329
|
|
|
1330
|
-
Returns **[Promise][
|
|
1330
|
+
Returns **[Promise][20]<[number][17]>** number of visible elements
|
|
1331
1331
|
|
|
1332
1332
|
### grabPageScrollPosition
|
|
1333
1333
|
|
|
@@ -1338,7 +1338,7 @@ Resumes test execution, so **should be used inside an async function with `await
|
|
|
1338
1338
|
let { x, y } = await I.grabPageScrollPosition();
|
|
1339
1339
|
```
|
|
1340
1340
|
|
|
1341
|
-
Returns **[Promise][
|
|
1341
|
+
Returns **[Promise][20]<PageScrollPosition>** scroll position
|
|
1342
1342
|
|
|
1343
1343
|
### grabPopupText
|
|
1344
1344
|
|
|
@@ -1348,7 +1348,7 @@ Grab the text within the popup. If no popup is visible then it will return null
|
|
|
1348
1348
|
await I.grabPopupText();
|
|
1349
1349
|
```
|
|
1350
1350
|
|
|
1351
|
-
Returns **[Promise][
|
|
1351
|
+
Returns **[Promise][20]<([string][7] | null)>** 
|
|
1352
1352
|
|
|
1353
1353
|
### grabRecordedNetworkTraffics
|
|
1354
1354
|
|
|
@@ -1372,7 +1372,7 @@ Resumes test execution, so **should be used inside async function with `await`**
|
|
|
1372
1372
|
let pageSource = await I.grabSource();
|
|
1373
1373
|
```
|
|
1374
1374
|
|
|
1375
|
-
Returns **[Promise][
|
|
1375
|
+
Returns **[Promise][20]<[string][7]>** source code
|
|
1376
1376
|
|
|
1377
1377
|
### grabStorageState
|
|
1378
1378
|
|
|
@@ -1411,7 +1411,7 @@ If multiple elements found returns first element.
|
|
|
1411
1411
|
|
|
1412
1412
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1413
1413
|
|
|
1414
|
-
Returns **[Promise][
|
|
1414
|
+
Returns **[Promise][20]<[string][7]>** attribute value
|
|
1415
1415
|
|
|
1416
1416
|
### grabTextFromAll
|
|
1417
1417
|
|
|
@@ -1426,7 +1426,7 @@ let pins = await I.grabTextFromAll('#pin li');
|
|
|
1426
1426
|
|
|
1427
1427
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1428
1428
|
|
|
1429
|
-
Returns **[Promise][
|
|
1429
|
+
Returns **[Promise][20]<[Array][9]<[string][7]>>** attribute value
|
|
1430
1430
|
|
|
1431
1431
|
### grabTitle
|
|
1432
1432
|
|
|
@@ -1437,7 +1437,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
|
|
|
1437
1437
|
let title = await I.grabTitle();
|
|
1438
1438
|
```
|
|
1439
1439
|
|
|
1440
|
-
Returns **[Promise][
|
|
1440
|
+
Returns **[Promise][20]<[string][7]>** title
|
|
1441
1441
|
|
|
1442
1442
|
### grabTrafficUrl
|
|
1443
1443
|
|
|
@@ -1454,7 +1454,7 @@ I.grabTrafficUrl(/session.*start/);
|
|
|
1454
1454
|
|
|
1455
1455
|
* `urlMatch` **([string][7] | [RegExp][10])** Expected URL of request in network traffic. Can be a string or a regular expression.
|
|
1456
1456
|
|
|
1457
|
-
Returns **[Promise][
|
|
1457
|
+
Returns **[Promise][20]<any>** 
|
|
1458
1458
|
|
|
1459
1459
|
### grabValueFrom
|
|
1460
1460
|
|
|
@@ -1470,7 +1470,7 @@ let email = await I.grabValueFrom('input[name=email]');
|
|
|
1470
1470
|
|
|
1471
1471
|
* `locator` **([string][7] | [object][8])** field located by label|name|CSS|XPath|strict locator.
|
|
1472
1472
|
|
|
1473
|
-
Returns **[Promise][
|
|
1473
|
+
Returns **[Promise][20]<[string][7]>** attribute value
|
|
1474
1474
|
|
|
1475
1475
|
### grabValueFromAll
|
|
1476
1476
|
|
|
@@ -1485,7 +1485,7 @@ let inputs = await I.grabValueFromAll('//form/input');
|
|
|
1485
1485
|
|
|
1486
1486
|
* `locator` **([string][7] | [object][8])** field located by label|name|CSS|XPath|strict locator.
|
|
1487
1487
|
|
|
1488
|
-
Returns **[Promise][
|
|
1488
|
+
Returns **[Promise][20]<[Array][9]<[string][7]>>** attribute value
|
|
1489
1489
|
|
|
1490
1490
|
### grabWebElement
|
|
1491
1491
|
|
|
@@ -1500,7 +1500,7 @@ const webElement = await I.grabWebElement('#button');
|
|
|
1500
1500
|
|
|
1501
1501
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1502
1502
|
|
|
1503
|
-
Returns **[Promise][
|
|
1503
|
+
Returns **[Promise][20]<CodeceptJS.WebElement>** WebElement of being used Web helper
|
|
1504
1504
|
|
|
1505
1505
|
### grabWebElements
|
|
1506
1506
|
|
|
@@ -1515,7 +1515,7 @@ const webElements = await I.grabWebElements('#button');
|
|
|
1515
1515
|
|
|
1516
1516
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1517
1517
|
|
|
1518
|
-
Returns **[Promise][
|
|
1518
|
+
Returns **[Promise][20]<[Array][9]<CodeceptJS.WebElement>>** WebElements of being used Web helper
|
|
1519
1519
|
|
|
1520
1520
|
### grabWebSocketMessages
|
|
1521
1521
|
|
|
@@ -1542,7 +1542,7 @@ I.waitForFile('avatar.jpg', 5);
|
|
|
1542
1542
|
|
|
1543
1543
|
* `fileName` **[string][7]** set filename for downloaded file
|
|
1544
1544
|
|
|
1545
|
-
Returns **[Promise][
|
|
1545
|
+
Returns **[Promise][20]<void>** 
|
|
1546
1546
|
|
|
1547
1547
|
### makeApiRequest
|
|
1548
1548
|
|
|
@@ -1563,7 +1563,7 @@ I.makeApiRequest('PATCH', )
|
|
|
1563
1563
|
* `url` **[string][7]** endpoint
|
|
1564
1564
|
* `options` **[object][8]** request options depending on method used
|
|
1565
1565
|
|
|
1566
|
-
Returns **[Promise][
|
|
1566
|
+
Returns **[Promise][20]<[object][8]>** response
|
|
1567
1567
|
|
|
1568
1568
|
### mockRoute
|
|
1569
1569
|
|
|
@@ -1578,7 +1578,7 @@ This method allows intercepting and mocking requests & responses. [Learn more ab
|
|
|
1578
1578
|
#### Parameters
|
|
1579
1579
|
|
|
1580
1580
|
* `url` **([string][7] | [RegExp][10])?** URL, regex or pattern for to match URL
|
|
1581
|
-
* `handler` **[function][
|
|
1581
|
+
* `handler` **[function][19]?** a function to process request
|
|
1582
1582
|
|
|
1583
1583
|
### mockTraffic
|
|
1584
1584
|
|
|
@@ -1619,7 +1619,7 @@ I.moveCursorTo('#submit', '.container');
|
|
|
1619
1619
|
* `offsetX` **([number][17] | [string][7] | [object][8])** (optional, `0` by default) X-axis offset or context locator.
|
|
1620
1620
|
* `offsetY` **[number][17]** (optional, `0` by default) Y-axis offset.
|
|
1621
1621
|
|
|
1622
|
-
Returns **
|
|
1622
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1623
1623
|
|
|
1624
1624
|
### openNewTab
|
|
1625
1625
|
|
|
@@ -1707,7 +1707,7 @@ Some of the supported key names are:
|
|
|
1707
1707
|
|
|
1708
1708
|
* `key` **([string][7] | [Array][9]<[string][7]>)** key or array of keys to press.
|
|
1709
1709
|
|
|
1710
|
-
Returns **
|
|
1710
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1711
1711
|
|
|
1712
1712
|
### pressKeyDown
|
|
1713
1713
|
|
|
@@ -1725,7 +1725,7 @@ I.pressKeyUp('Control');
|
|
|
1725
1725
|
|
|
1726
1726
|
* `key` **[string][7]** name of key to press down.
|
|
1727
1727
|
|
|
1728
|
-
Returns **
|
|
1728
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1729
1729
|
|
|
1730
1730
|
### pressKeyUp
|
|
1731
1731
|
|
|
@@ -1743,7 +1743,7 @@ I.pressKeyUp('Control');
|
|
|
1743
1743
|
|
|
1744
1744
|
* `key` **[string][7]** name of key to release.
|
|
1745
1745
|
|
|
1746
|
-
Returns **
|
|
1746
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1747
1747
|
|
|
1748
1748
|
### refreshPage
|
|
1749
1749
|
|
|
@@ -1753,7 +1753,7 @@ Reload the current page.
|
|
|
1753
1753
|
I.refreshPage();
|
|
1754
1754
|
```
|
|
1755
1755
|
|
|
1756
|
-
Returns **
|
|
1756
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1757
1757
|
|
|
1758
1758
|
### replayFromHar
|
|
1759
1759
|
|
|
@@ -1797,7 +1797,7 @@ First parameter can be set to `maximize`.
|
|
|
1797
1797
|
* `width` **[number][17]** width in pixels or `maximize`.
|
|
1798
1798
|
* `height` **[number][17]** height in pixels.
|
|
1799
1799
|
|
|
1800
|
-
Returns **
|
|
1800
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1801
1801
|
|
|
1802
1802
|
### rightClick
|
|
1803
1803
|
|
|
@@ -1817,7 +1817,7 @@ I.rightClick('Click me', '.context');
|
|
|
1817
1817
|
* `locator` **([string][7] | [object][8])** clickable element located by CSS|XPath|strict locator.
|
|
1818
1818
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
1819
1819
|
|
|
1820
|
-
Returns **
|
|
1820
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1821
1821
|
|
|
1822
1822
|
### saveElementScreenshot
|
|
1823
1823
|
|
|
@@ -1833,7 +1833,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
|
|
|
1833
1833
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
1834
1834
|
* `fileName` **[string][7]** file name to save.
|
|
1835
1835
|
|
|
1836
|
-
Returns **
|
|
1836
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1837
1837
|
|
|
1838
1838
|
### saveScreenshot
|
|
1839
1839
|
|
|
@@ -1851,7 +1851,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
|
|
|
1851
1851
|
* `fileName` **[string][7]** file name to save.
|
|
1852
1852
|
* `fullPage` **[boolean][26]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
1853
1853
|
|
|
1854
|
-
Returns **
|
|
1854
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1855
1855
|
|
|
1856
1856
|
### scrollPageToBottom
|
|
1857
1857
|
|
|
@@ -1861,7 +1861,7 @@ Scroll page to the bottom.
|
|
|
1861
1861
|
I.scrollPageToBottom();
|
|
1862
1862
|
```
|
|
1863
1863
|
|
|
1864
|
-
Returns **
|
|
1864
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1865
1865
|
|
|
1866
1866
|
### scrollPageToTop
|
|
1867
1867
|
|
|
@@ -1871,7 +1871,7 @@ Scroll page to the top.
|
|
|
1871
1871
|
I.scrollPageToTop();
|
|
1872
1872
|
```
|
|
1873
1873
|
|
|
1874
|
-
Returns **
|
|
1874
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1875
1875
|
|
|
1876
1876
|
### scrollTo
|
|
1877
1877
|
|
|
@@ -1889,7 +1889,7 @@ I.scrollTo('#submit', 5, 5);
|
|
|
1889
1889
|
* `offsetX` **[number][17]** (optional, `0` by default) X-axis offset.
|
|
1890
1890
|
* `offsetY` **[number][17]** (optional, `0` by default) Y-axis offset.
|
|
1891
1891
|
|
|
1892
|
-
Returns **
|
|
1892
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
1893
1893
|
|
|
1894
1894
|
### see
|
|
1895
1895
|
|
|
@@ -1907,7 +1907,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
|
|
|
1907
1907
|
* `text` **[string][7]** expected on page.
|
|
1908
1908
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
1909
1909
|
|
|
1910
|
-
Returns **
|
|
1910
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1911
1911
|
|
|
1912
1912
|
### seeAttributesOnElements
|
|
1913
1913
|
|
|
@@ -1922,7 +1922,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
|
|
|
1922
1922
|
* `locator` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
1923
1923
|
* `attributes` **[object][8]** attributes and their values to check.
|
|
1924
1924
|
|
|
1925
|
-
Returns **
|
|
1925
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1926
1926
|
|
|
1927
1927
|
### seeCheckboxIsChecked
|
|
1928
1928
|
|
|
@@ -1938,7 +1938,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
|
|
|
1938
1938
|
|
|
1939
1939
|
* `field` **([string][7] | [object][8])** located by label|name|CSS|XPath|strict locator.
|
|
1940
1940
|
|
|
1941
|
-
Returns **
|
|
1941
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1942
1942
|
|
|
1943
1943
|
### seeClipboardEquals
|
|
1944
1944
|
|
|
@@ -1956,7 +1956,7 @@ in Chromium-based browsers, where read access is granted automatically.
|
|
|
1956
1956
|
|
|
1957
1957
|
* `text` **[string][7]** value to check.
|
|
1958
1958
|
|
|
1959
|
-
Returns **
|
|
1959
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1960
1960
|
|
|
1961
1961
|
### seeCookie
|
|
1962
1962
|
|
|
@@ -1970,7 +1970,7 @@ I.seeCookie('Auth');
|
|
|
1970
1970
|
|
|
1971
1971
|
* `name` **[string][7]** cookie name.
|
|
1972
1972
|
|
|
1973
|
-
Returns **
|
|
1973
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1974
1974
|
|
|
1975
1975
|
### seeCssPropertiesOnElements
|
|
1976
1976
|
|
|
@@ -1985,7 +1985,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
|
|
|
1985
1985
|
* `locator` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
1986
1986
|
* `cssProperties` **[object][8]** object with CSS properties and their values to check.
|
|
1987
1987
|
|
|
1988
|
-
Returns **
|
|
1988
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
1989
1989
|
|
|
1990
1990
|
### seeCurrentPathEquals
|
|
1991
1991
|
|
|
@@ -2001,7 +2001,7 @@ I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
|
|
|
2001
2001
|
|
|
2002
2002
|
* `path` **[string][7]** value to check.
|
|
2003
2003
|
|
|
2004
|
-
Returns **
|
|
2004
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2005
2005
|
|
|
2006
2006
|
### seeCurrentUrlEquals
|
|
2007
2007
|
|
|
@@ -2018,7 +2018,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
|
|
|
2018
2018
|
|
|
2019
2019
|
* `url` **[string][7]** value to check.
|
|
2020
2020
|
|
|
2021
|
-
Returns **
|
|
2021
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2022
2022
|
|
|
2023
2023
|
### seeElement
|
|
2024
2024
|
|
|
@@ -2041,7 +2041,7 @@ I.seeElement({role: 'dialog'});
|
|
|
2041
2041
|
* `locator` **([string][7] | [object][8])** located by CSS|XPath|strict locator.
|
|
2042
2042
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2043
2043
|
|
|
2044
|
-
Returns **
|
|
2044
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2045
2045
|
|
|
2046
2046
|
### seeElementInDOM
|
|
2047
2047
|
|
|
@@ -2056,7 +2056,7 @@ I.seeElementInDOM('#modal');
|
|
|
2056
2056
|
|
|
2057
2057
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2058
2058
|
|
|
2059
|
-
Returns **
|
|
2059
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2060
2060
|
|
|
2061
2061
|
### seeInClipboard
|
|
2062
2062
|
|
|
@@ -2074,7 +2074,7 @@ in Chromium-based browsers, where read access is granted automatically.
|
|
|
2074
2074
|
|
|
2075
2075
|
* `text` **[string][7]** value to check.
|
|
2076
2076
|
|
|
2077
|
-
Returns **
|
|
2077
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2078
2078
|
|
|
2079
2079
|
### seeInCurrentUrl
|
|
2080
2080
|
|
|
@@ -2088,7 +2088,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
|
|
|
2088
2088
|
|
|
2089
2089
|
* `url` **[string][7]** a fragment to check
|
|
2090
2090
|
|
|
2091
|
-
Returns **
|
|
2091
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2092
2092
|
|
|
2093
2093
|
### seeInField
|
|
2094
2094
|
|
|
@@ -2112,7 +2112,7 @@ I.seeInField('Name', 'John', '.form-container');
|
|
|
2112
2112
|
* `value` **([string][7] | [object][8])** value to check.
|
|
2113
2113
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2114
2114
|
|
|
2115
|
-
Returns **
|
|
2115
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2116
2116
|
|
|
2117
2117
|
### seeInPopup
|
|
2118
2118
|
|
|
@@ -2127,7 +2127,7 @@ I.seeInPopup('Popup text');
|
|
|
2127
2127
|
|
|
2128
2128
|
* `text` **[string][7]** value to check.
|
|
2129
2129
|
|
|
2130
|
-
Returns **
|
|
2130
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2131
2131
|
|
|
2132
2132
|
### seeInSource
|
|
2133
2133
|
|
|
@@ -2141,7 +2141,7 @@ I.seeInSource('<h1>Green eggs & ham</h1>');
|
|
|
2141
2141
|
|
|
2142
2142
|
* `text` **[string][7]** value to check.
|
|
2143
2143
|
|
|
2144
|
-
Returns **
|
|
2144
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2145
2145
|
|
|
2146
2146
|
### seeInTitle
|
|
2147
2147
|
|
|
@@ -2155,7 +2155,7 @@ I.seeInTitle('Home Page');
|
|
|
2155
2155
|
|
|
2156
2156
|
* `text` **[string][7]** text value to check.
|
|
2157
2157
|
|
|
2158
|
-
Returns **
|
|
2158
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2159
2159
|
|
|
2160
2160
|
### seeNumberOfElements
|
|
2161
2161
|
|
|
@@ -2171,7 +2171,7 @@ I.seeNumberOfElements('#submitBtn', 1);
|
|
|
2171
2171
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2172
2172
|
* `num` **[number][17]** number of elements.
|
|
2173
2173
|
|
|
2174
|
-
Returns **
|
|
2174
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2175
2175
|
|
|
2176
2176
|
### seeNumberOfVisibleElements
|
|
2177
2177
|
|
|
@@ -2187,7 +2187,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
|
|
|
2187
2187
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2188
2188
|
* `num` **[number][17]** number of elements.
|
|
2189
2189
|
|
|
2190
|
-
Returns **
|
|
2190
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2191
2191
|
|
|
2192
2192
|
### seeTextEquals
|
|
2193
2193
|
|
|
@@ -2202,7 +2202,7 @@ I.seeTextEquals('text', 'h1');
|
|
|
2202
2202
|
* `text` **[string][7]** element value to check.
|
|
2203
2203
|
* `context` **([string][7] | [object][8])?** element located by CSS|XPath|strict locator.
|
|
2204
2204
|
|
|
2205
|
-
Returns **
|
|
2205
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2206
2206
|
|
|
2207
2207
|
### seeTitleEquals
|
|
2208
2208
|
|
|
@@ -2216,7 +2216,7 @@ I.seeTitleEquals('Test title.');
|
|
|
2216
2216
|
|
|
2217
2217
|
* `text` **[string][7]** value to check.
|
|
2218
2218
|
|
|
2219
|
-
Returns **
|
|
2219
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2220
2220
|
|
|
2221
2221
|
### seeTraffic
|
|
2222
2222
|
|
|
@@ -2292,7 +2292,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
|
|
|
2292
2292
|
* `option` **([string][7] | [Array][9]<any>)** visible text or value of option.
|
|
2293
2293
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2294
2294
|
|
|
2295
|
-
Returns **
|
|
2295
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
2296
2296
|
|
|
2297
2297
|
### setCookie
|
|
2298
2298
|
|
|
@@ -2314,7 +2314,7 @@ I.setCookie([
|
|
|
2314
2314
|
|
|
2315
2315
|
* `cookie` **(Cookie | [Array][9]<Cookie>)** a cookie object or array of cookie objects.
|
|
2316
2316
|
|
|
2317
|
-
Returns **
|
|
2317
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2318
2318
|
|
|
2319
2319
|
### setPlaywrightRequestHeaders
|
|
2320
2320
|
|
|
@@ -2339,7 +2339,7 @@ This also resets recorded network requests.
|
|
|
2339
2339
|
I.startRecordingTraffic();
|
|
2340
2340
|
```
|
|
2341
2341
|
|
|
2342
|
-
Returns **
|
|
2342
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2343
2343
|
|
|
2344
2344
|
### startRecordingWebSocketMessages
|
|
2345
2345
|
|
|
@@ -2350,7 +2350,7 @@ This also resets recorded websocket messages.
|
|
|
2350
2350
|
await I.startRecordingWebSocketMessages();
|
|
2351
2351
|
```
|
|
2352
2352
|
|
|
2353
|
-
Returns **
|
|
2353
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2354
2354
|
|
|
2355
2355
|
### stopMockingRoute
|
|
2356
2356
|
|
|
@@ -2366,7 +2366,7 @@ If no handler is passed, all mock requests for the rote are disabled.
|
|
|
2366
2366
|
#### Parameters
|
|
2367
2367
|
|
|
2368
2368
|
* `url` **([string][7] | [RegExp][10])?** URL, regex or pattern for to match URL
|
|
2369
|
-
* `handler` **[function][
|
|
2369
|
+
* `handler` **[function][19]?** a function to process request
|
|
2370
2370
|
|
|
2371
2371
|
### stopRecordingTraffic
|
|
2372
2372
|
|
|
@@ -2384,7 +2384,7 @@ Stops recording WS messages. Recorded WS messages is not flashed.
|
|
|
2384
2384
|
await I.stopRecordingWebSocketMessages();
|
|
2385
2385
|
```
|
|
2386
2386
|
|
|
2387
|
-
Returns **
|
|
2387
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2388
2388
|
|
|
2389
2389
|
### switchTo
|
|
2390
2390
|
|
|
@@ -2399,7 +2399,7 @@ I.switchTo(); // switch back to main page
|
|
|
2399
2399
|
|
|
2400
2400
|
* `locator` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
2401
2401
|
|
|
2402
|
-
Returns **
|
|
2402
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2403
2403
|
|
|
2404
2404
|
### switchToNextTab
|
|
2405
2405
|
|
|
@@ -2453,7 +2453,7 @@ I.type(secret('123456'));
|
|
|
2453
2453
|
* `delay` **[number][17]?** (optional) delay in ms between key presses
|
|
2454
2454
|
* `key` **([string][7] | [Array][9]<[string][7]>)** or array of keys to type.
|
|
2455
2455
|
|
|
2456
|
-
Returns **
|
|
2456
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2457
2457
|
|
|
2458
2458
|
### uncheckOption
|
|
2459
2459
|
|
|
@@ -2485,7 +2485,7 @@ I.uncheckOption('agree', '//form');
|
|
|
2485
2485
|
* `context` **([string][7]? | [object][8])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2486
2486
|
* `options`
|
|
2487
2487
|
|
|
2488
|
-
Returns **
|
|
2488
|
+
Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
|
|
2489
2489
|
|
|
2490
2490
|
### usePlaywrightTo
|
|
2491
2491
|
|
|
@@ -2505,7 +2505,7 @@ I.usePlaywrightTo('emulate offline mode', async ({ browserContext }) => {
|
|
|
2505
2505
|
#### Parameters
|
|
2506
2506
|
|
|
2507
2507
|
* `description` **[string][7]** used to show in logs.
|
|
2508
|
-
* `fn` **[function][
|
|
2508
|
+
* `fn` **[function][19]** async function that executed with Playwright helper as arguments
|
|
2509
2509
|
|
|
2510
2510
|
### wait
|
|
2511
2511
|
|
|
@@ -2519,7 +2519,7 @@ I.wait(2); // wait 2 secs
|
|
|
2519
2519
|
|
|
2520
2520
|
* `sec` **[number][17]** number of second to wait.
|
|
2521
2521
|
|
|
2522
|
-
Returns **
|
|
2522
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2523
2523
|
|
|
2524
2524
|
### waitCurrentPathEquals
|
|
2525
2525
|
|
|
@@ -2546,7 +2546,7 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
|
|
|
2546
2546
|
* `waitTimeout`  
|
|
2547
2547
|
* `sec` **[number][17]?** (optional, `1` by default) time in seconds to wait
|
|
2548
2548
|
|
|
2549
|
-
Returns **
|
|
2549
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2550
2550
|
|
|
2551
2551
|
### waitForCookie
|
|
2552
2552
|
|
|
@@ -2561,7 +2561,7 @@ I.waitForCookie("token");
|
|
|
2561
2561
|
* `name` **[string][7]** expected cookie name.
|
|
2562
2562
|
* `sec` **[number][17]** (optional, `3` by default) time in seconds to wait
|
|
2563
2563
|
|
|
2564
|
-
Returns **
|
|
2564
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2565
2565
|
|
|
2566
2566
|
### waitForDetached
|
|
2567
2567
|
|
|
@@ -2577,7 +2577,7 @@ I.waitForDetached('#popup');
|
|
|
2577
2577
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2578
2578
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2579
2579
|
|
|
2580
|
-
Returns **
|
|
2580
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2581
2581
|
|
|
2582
2582
|
### waitForDisabled
|
|
2583
2583
|
|
|
@@ -2589,7 +2589,7 @@ Element can be located by CSS or XPath.
|
|
|
2589
2589
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2590
2590
|
* `sec` **[number][17]** (optional) time in seconds to wait, 1 by default.
|
|
2591
2591
|
|
|
2592
|
-
Returns **
|
|
2592
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2593
2593
|
|
|
2594
2594
|
### waitForElement
|
|
2595
2595
|
|
|
@@ -2606,7 +2606,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
|
|
|
2606
2606
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2607
2607
|
* `sec` **[number][17]?** (optional, `1` by default) time in seconds to wait
|
|
2608
2608
|
|
|
2609
|
-
Returns **
|
|
2609
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2610
2610
|
|
|
2611
2611
|
### waitForEnabled
|
|
2612
2612
|
|
|
@@ -2618,7 +2618,7 @@ Element can be located by CSS or XPath.
|
|
|
2618
2618
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2619
2619
|
* `sec` **[number][17]** (optional) time in seconds to wait, 1 by default.
|
|
2620
2620
|
|
|
2621
|
-
Returns **
|
|
2621
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2622
2622
|
|
|
2623
2623
|
### waitForFunction
|
|
2624
2624
|
|
|
@@ -2637,11 +2637,11 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
|
|
|
2637
2637
|
|
|
2638
2638
|
#### Parameters
|
|
2639
2639
|
|
|
2640
|
-
* `fn` **([string][7] | [function][
|
|
2640
|
+
* `fn` **([string][7] | [function][19])** to be executed in browser context.
|
|
2641
2641
|
* `argsOrSec` **([Array][9]<any> | [number][17])?** (optional, `1` by default) arguments for function or seconds.
|
|
2642
2642
|
* `sec` **[number][17]?** (optional, `1` by default) time in seconds to wait
|
|
2643
2643
|
|
|
2644
|
-
Returns **
|
|
2644
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2645
2645
|
|
|
2646
2646
|
### waitForInvisible
|
|
2647
2647
|
|
|
@@ -2657,7 +2657,7 @@ I.waitForInvisible('#popup');
|
|
|
2657
2657
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2658
2658
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2659
2659
|
|
|
2660
|
-
Returns **
|
|
2660
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2661
2661
|
|
|
2662
2662
|
### waitForNavigation
|
|
2663
2663
|
|
|
@@ -2682,7 +2682,7 @@ I.waitForNumberOfTabs(2);
|
|
|
2682
2682
|
* `expectedTabs` **[number][17]** expecting the number of tabs.
|
|
2683
2683
|
* `sec` **[number][17]** number of secs to wait.
|
|
2684
2684
|
|
|
2685
|
-
Returns **
|
|
2685
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2686
2686
|
|
|
2687
2687
|
### waitForRequest
|
|
2688
2688
|
|
|
@@ -2695,7 +2695,7 @@ I.waitForRequest(request => request.url() === 'http://example.com' && request.me
|
|
|
2695
2695
|
|
|
2696
2696
|
#### Parameters
|
|
2697
2697
|
|
|
2698
|
-
* `urlOrPredicate` **([string][7] | [function][
|
|
2698
|
+
* `urlOrPredicate` **([string][7] | [function][19])** 
|
|
2699
2699
|
* `sec` **[number][17]?** seconds to wait
|
|
2700
2700
|
|
|
2701
2701
|
### waitForResponse
|
|
@@ -2709,7 +2709,7 @@ I.waitForResponse(response => response.url() === 'https://example.com' && respon
|
|
|
2709
2709
|
|
|
2710
2710
|
#### Parameters
|
|
2711
2711
|
|
|
2712
|
-
* `urlOrPredicate` **([string][7] | [function][
|
|
2712
|
+
* `urlOrPredicate` **([string][7] | [function][19])** 
|
|
2713
2713
|
* `sec` **[number][17]?** number of seconds to wait
|
|
2714
2714
|
|
|
2715
2715
|
### waitForText
|
|
@@ -2729,7 +2729,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
|
|
|
2729
2729
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2730
2730
|
* `context` **([string][7] | [object][8])?** (optional) element located by CSS|XPath|strict locator.
|
|
2731
2731
|
|
|
2732
|
-
Returns **
|
|
2732
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder. **Note:** Text matching is case-sensitive. For case-insensitive matching, use XPath or CSS locators with normalized text.
|
|
2733
2733
|
|
|
2734
2734
|
### waitForURL
|
|
2735
2735
|
|
|
@@ -2756,7 +2756,7 @@ I.waitForValue('//input', "GoodValue");
|
|
|
2756
2756
|
* `value` **[string][7]** expected value.
|
|
2757
2757
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2758
2758
|
|
|
2759
|
-
Returns **
|
|
2759
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2760
2760
|
|
|
2761
2761
|
### waitForVisible
|
|
2762
2762
|
|
|
@@ -2772,7 +2772,7 @@ I.waitForVisible('#popup');
|
|
|
2772
2772
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2773
2773
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2774
2774
|
|
|
2775
|
-
Returns **
|
|
2775
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2776
2776
|
|
|
2777
2777
|
### waitInUrl
|
|
2778
2778
|
|
|
@@ -2787,7 +2787,7 @@ I.waitInUrl('/info', 2);
|
|
|
2787
2787
|
* `urlPart` **[string][7]** value to check.
|
|
2788
2788
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2789
2789
|
|
|
2790
|
-
Returns **
|
|
2790
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2791
2791
|
|
|
2792
2792
|
### waitNumberOfVisibleElements
|
|
2793
2793
|
|
|
@@ -2803,7 +2803,7 @@ I.waitNumberOfVisibleElements('a', 3);
|
|
|
2803
2803
|
* `num` **[number][17]** number of elements.
|
|
2804
2804
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2805
2805
|
|
|
2806
|
-
Returns **
|
|
2806
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2807
2807
|
|
|
2808
2808
|
### waitToHide
|
|
2809
2809
|
|
|
@@ -2819,7 +2819,7 @@ I.waitToHide('#popup');
|
|
|
2819
2819
|
* `locator` **([string][7] | [object][8])** element located by CSS|XPath|strict locator.
|
|
2820
2820
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2821
2821
|
|
|
2822
|
-
Returns **
|
|
2822
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2823
2823
|
|
|
2824
2824
|
### waitUrlEquals
|
|
2825
2825
|
|
|
@@ -2835,7 +2835,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
|
|
|
2835
2835
|
* `urlPart` **[string][7]** value to check.
|
|
2836
2836
|
* `sec` **[number][17]** (optional, `1` by default) time in seconds to wait
|
|
2837
2837
|
|
|
2838
|
-
Returns **
|
|
2838
|
+
Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
|
|
2839
2839
|
|
|
2840
2840
|
### _addPopupListener
|
|
2841
2841
|
|
|
@@ -2972,11 +2972,11 @@ Set current page
|
|
|
2972
2972
|
|
|
2973
2973
|
[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
|
|
2974
2974
|
|
|
2975
|
-
[18]: https://
|
|
2975
|
+
[18]: https://playwright.dev/docs/api/class-page#page-drag-and-drop
|
|
2976
2976
|
|
|
2977
|
-
[19]: https://
|
|
2977
|
+
[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
|
|
2978
2978
|
|
|
2979
|
-
[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/
|
|
2979
|
+
[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
|
|
2980
2980
|
|
|
2981
2981
|
[21]: https://playwright.dev/docs/api/class-locator#locator-focus
|
|
2982
2982
|
|