codeceptjs 3.3.5-beta.6 → 3.3.6
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/CHANGELOG.md +69 -2
- package/bin/codecept.js +40 -3
- package/docs/basics.md +24 -1
- package/docs/build/Appium.js +41 -22
- package/docs/build/FileSystem.js +1 -1
- package/docs/build/Nightmare.js +106 -57
- package/docs/build/Playwright.js +187 -111
- package/docs/build/Protractor.js +132 -70
- package/docs/build/Puppeteer.js +143 -76
- package/docs/build/REST.js +2 -2
- package/docs/build/TestCafe.js +107 -57
- package/docs/build/WebDriver.js +162 -89
- package/docs/changelog.md +107 -2
- package/docs/commands.md +5 -3
- package/docs/community-helpers.md +7 -4
- package/docs/configuration.md +5 -5
- package/docs/examples.md +39 -48
- package/docs/helpers/Appium.md +25 -23
- package/docs/helpers/FileSystem.md +1 -1
- package/docs/helpers/Nightmare.md +57 -57
- package/docs/helpers/Playwright.md +76 -75
- package/docs/helpers/Puppeteer.md +76 -85
- package/docs/helpers/REST.md +1 -1
- package/docs/helpers/TestCafe.md +57 -57
- package/docs/helpers/WebDriver.md +84 -97
- package/docs/quickstart.md +1 -1
- package/docs/reports.md +1 -1
- package/docs/secrets.md +1 -1
- package/docs/typescript.md +9 -69
- package/docs/webapi/appendField.mustache +1 -1
- package/docs/webapi/attachFile.mustache +3 -3
- package/docs/webapi/checkOption.mustache +1 -1
- package/docs/webapi/clearCookie.mustache +1 -1
- package/docs/webapi/clearField.mustache +1 -1
- package/docs/webapi/click.mustache +1 -1
- package/docs/webapi/clickLink.mustache +1 -1
- package/docs/webapi/closeCurrentTab.mustache +1 -1
- package/docs/webapi/closeOtherTabs.mustache +1 -1
- package/docs/webapi/dontSee.mustache +1 -1
- package/docs/webapi/dontSeeCheckboxIsChecked.mustache +1 -1
- package/docs/webapi/dontSeeCookie.mustache +1 -1
- package/docs/webapi/dontSeeCurrentUrlEquals.mustache +1 -1
- package/docs/webapi/dontSeeElement.mustache +1 -1
- package/docs/webapi/dontSeeElementInDOM.mustache +1 -1
- package/docs/webapi/dontSeeInCurrentUrl.mustache +1 -1
- package/docs/webapi/dontSeeInField.mustache +1 -1
- package/docs/webapi/dontSeeInSource.mustache +1 -1
- package/docs/webapi/dontSeeInTitle.mustache +1 -1
- package/docs/webapi/doubleClick.mustache +1 -1
- package/docs/webapi/downloadFile.mustache +1 -1
- package/docs/webapi/dragAndDrop.mustache +1 -1
- package/docs/webapi/dragSlider.mustache +1 -1
- package/docs/webapi/executeAsyncScript.mustache +1 -1
- package/docs/webapi/executeScript.mustache +1 -1
- package/docs/webapi/fillField.mustache +1 -1
- package/docs/webapi/forceClick.mustache +1 -1
- package/docs/webapi/forceRightClick.mustache +1 -1
- package/docs/webapi/moveCursorTo.mustache +1 -1
- package/docs/webapi/openNewTab.mustache +1 -1
- package/docs/webapi/pressKey.mustache +1 -1
- package/docs/webapi/pressKeyDown.mustache +1 -1
- package/docs/webapi/pressKeyUp.mustache +1 -1
- package/docs/webapi/pressKeyWithKeyNormalization.mustache +1 -1
- package/docs/webapi/refreshPage.mustache +1 -1
- package/docs/webapi/resizeWindow.mustache +1 -1
- package/docs/webapi/rightClick.mustache +1 -1
- package/docs/webapi/saveElementScreenshot.mustache +2 -2
- package/docs/webapi/saveScreenshot.mustache +2 -2
- package/docs/webapi/say.mustache +1 -1
- package/docs/webapi/scrollIntoView.mustache +1 -1
- package/docs/webapi/scrollPageToBottom.mustache +1 -1
- package/docs/webapi/scrollPageToTop.mustache +1 -1
- package/docs/webapi/scrollTo.mustache +1 -1
- package/docs/webapi/see.mustache +1 -1
- package/docs/webapi/seeAttributesOnElements.mustache +1 -1
- package/docs/webapi/seeCheckboxIsChecked.mustache +1 -1
- package/docs/webapi/seeCookie.mustache +1 -1
- package/docs/webapi/seeCssPropertiesOnElements.mustache +1 -1
- package/docs/webapi/seeCurrentUrlEquals.mustache +1 -1
- package/docs/webapi/seeElement.mustache +1 -1
- package/docs/webapi/seeElementInDOM.mustache +1 -1
- package/docs/webapi/seeInCurrentUrl.mustache +1 -1
- package/docs/webapi/seeInField.mustache +1 -1
- package/docs/webapi/seeInPopup.mustache +1 -1
- package/docs/webapi/seeInSource.mustache +1 -1
- package/docs/webapi/seeInTitle.mustache +1 -1
- package/docs/webapi/seeNumberOfElements.mustache +1 -1
- package/docs/webapi/seeNumberOfVisibleElements.mustache +1 -1
- package/docs/webapi/seeTextEquals.mustache +1 -1
- package/docs/webapi/seeTitleEquals.mustache +1 -1
- package/docs/webapi/selectOption.mustache +1 -1
- package/docs/webapi/setCookie.mustache +1 -1
- package/docs/webapi/setGeoLocation.mustache +1 -1
- package/docs/webapi/switchTo.mustache +1 -1
- package/docs/webapi/switchToNextTab.mustache +1 -1
- package/docs/webapi/switchToPreviousTab.mustache +1 -1
- package/docs/webapi/type.mustache +1 -1
- package/docs/webapi/uncheckOption.mustache +1 -1
- package/docs/webapi/wait.mustache +1 -1
- package/docs/webapi/waitForClickable.mustache +1 -1
- package/docs/webapi/waitForDetached.mustache +1 -1
- package/docs/webapi/waitForElement.mustache +1 -1
- package/docs/webapi/waitForEnabled.mustache +1 -1
- package/docs/webapi/waitForFunction.mustache +1 -1
- package/docs/webapi/waitForInvisible.mustache +1 -1
- package/docs/webapi/waitForText.mustache +1 -1
- package/docs/webapi/waitForValue.mustache +1 -1
- package/docs/webapi/waitForVisible.mustache +1 -1
- package/docs/webapi/waitInUrl.mustache +1 -1
- package/docs/webapi/waitNumberOfVisibleElements.mustache +1 -1
- package/docs/webapi/waitToHide.mustache +1 -1
- package/docs/webapi/waitUrlEquals.mustache +1 -1
- package/lib/command/configMigrate.js +1 -1
- package/lib/command/dryRun.js +2 -1
- package/lib/command/generate.js +35 -18
- package/lib/command/run-rerun.js +38 -0
- package/lib/command/utils.js +13 -3
- package/lib/config.js +2 -2
- package/lib/data/context.js +7 -0
- package/lib/helper/Appium.js +6 -4
- package/lib/helper/FileSystem.js +1 -1
- package/lib/helper/Nightmare.js +1 -1
- package/lib/helper/Playwright.js +48 -38
- package/lib/helper/Protractor.js +1 -1
- package/lib/helper/REST.js +2 -2
- package/lib/helper/TestCafe.js +1 -1
- package/lib/helper/WebDriver.js +7 -7
- package/lib/plugin/wdio.js +11 -2
- package/lib/utils.js +3 -0
- package/package.json +2 -2
- package/typings/index.d.ts +46 -46
- package/typings/types.d.ts +497 -443
- package/docs/wiki/.git/FETCH_HEAD +0 -1
- package/docs/wiki/.git/HEAD +0 -1
- package/docs/wiki/.git/ORIG_HEAD +0 -1
- package/docs/wiki/.git/config +0 -11
- package/docs/wiki/.git/description +0 -1
- package/docs/wiki/.git/hooks/applypatch-msg.sample +0 -15
- package/docs/wiki/.git/hooks/commit-msg.sample +0 -24
- package/docs/wiki/.git/hooks/fsmonitor-watchman.sample +0 -173
- package/docs/wiki/.git/hooks/post-update.sample +0 -8
- package/docs/wiki/.git/hooks/pre-applypatch.sample +0 -14
- package/docs/wiki/.git/hooks/pre-commit.sample +0 -49
- package/docs/wiki/.git/hooks/pre-merge-commit.sample +0 -13
- package/docs/wiki/.git/hooks/pre-push.sample +0 -53
- package/docs/wiki/.git/hooks/pre-rebase.sample +0 -169
- package/docs/wiki/.git/hooks/pre-receive.sample +0 -24
- package/docs/wiki/.git/hooks/prepare-commit-msg.sample +0 -42
- package/docs/wiki/.git/hooks/push-to-checkout.sample +0 -78
- package/docs/wiki/.git/hooks/update.sample +0 -128
- package/docs/wiki/.git/index +0 -0
- package/docs/wiki/.git/info/exclude +0 -6
- package/docs/wiki/.git/logs/HEAD +0 -1
- package/docs/wiki/.git/logs/refs/heads/master +0 -1
- package/docs/wiki/.git/logs/refs/remotes/origin/HEAD +0 -1
- package/docs/wiki/.git/objects/pack/pack-5938044f9d30daf1c195fda4dec1d54850933935.idx +0 -0
- package/docs/wiki/.git/objects/pack/pack-5938044f9d30daf1c195fda4dec1d54850933935.pack +0 -0
- package/docs/wiki/.git/packed-refs +0 -2
- package/docs/wiki/.git/refs/heads/master +0 -1
- package/docs/wiki/.git/refs/remotes/origin/HEAD +0 -1
|
@@ -30,11 +30,11 @@ Type: [object][16]
|
|
|
30
30
|
- `browser` **[string][17]** browser in which to perform testing.
|
|
31
31
|
- `basicAuth` **[string][17]?** (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
|
|
32
32
|
- `host` **[string][17]?** WebDriver host to connect.
|
|
33
|
-
- `port` **[
|
|
33
|
+
- `port` **[number][20]?** WebDriver port to connect.
|
|
34
34
|
- `protocol` **[string][17]?** protocol for WebDriver server.
|
|
35
35
|
- `path` **[string][17]?** path to WebDriver server,
|
|
36
36
|
- `restart` **[boolean][29]?** restart browser between tests.
|
|
37
|
-
- `smartWait` **[boolean][29]?** **enables [SmartWait][33]**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
|
|
37
|
+
- `smartWait` **([boolean][29] | [number][20])?** **enables [SmartWait][33]**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
|
|
38
38
|
- `disableScreenshots` **[boolean][29]?** don't save screenshots on failure.
|
|
39
39
|
- `fullPageScreenshots` **[boolean][29]?** (optional - make full page screenshots on failure.
|
|
40
40
|
- `uniqueScreenshotNames` **[boolean][29]?** option to prevent screenshot override if you have scenarios with the same name in different suites.
|
|
@@ -470,8 +470,7 @@ I.appendField('#myTextField', 'appended');
|
|
|
470
470
|
|
|
471
471
|
- `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator
|
|
472
472
|
- `value` **[string][17]** text value to append.
|
|
473
|
-
|
|
474
|
-
|
|
473
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
475
474
|
|
|
476
475
|
|
|
477
476
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -480,7 +479,7 @@ This action supports [React locators](https://codecept.io/react#locators)
|
|
|
480
479
|
### attachFile
|
|
481
480
|
|
|
482
481
|
Attaches a file to element located by label, name, CSS or XPath
|
|
483
|
-
Path to file is relative current codecept directory (where codecept.
|
|
482
|
+
Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
484
483
|
File will be uploaded to remote system (if tests are running remotely).
|
|
485
484
|
|
|
486
485
|
```js
|
|
@@ -491,9 +490,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
|
|
|
491
490
|
#### Parameters
|
|
492
491
|
|
|
493
492
|
- `locator` **([string][17] | [object][16])** field located by label|name|CSS|XPath|strict locator.
|
|
494
|
-
- `pathToFile` **[string][17]** local file path relative to codecept.
|
|
495
|
-
|
|
496
|
-
Appium: not tested
|
|
493
|
+
- `pathToFile` **[string][17]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
|
|
494
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested
|
|
497
495
|
|
|
498
496
|
### cancelPopup
|
|
499
497
|
|
|
@@ -516,8 +514,7 @@ I.checkOption('agree', '//form');
|
|
|
516
514
|
|
|
517
515
|
- `field` **([string][17] | [object][16])** checkbox located by label | name | CSS | XPath | strict locator.
|
|
518
516
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
519
|
-
|
|
520
|
-
Appium: not tested
|
|
517
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested
|
|
521
518
|
|
|
522
519
|
### clearCookie
|
|
523
520
|
|
|
@@ -532,7 +529,7 @@ I.clearCookie('test');
|
|
|
532
529
|
#### Parameters
|
|
533
530
|
|
|
534
531
|
- `cookie` **[string][17]?** (optional, `null` by default) cookie name
|
|
535
|
-
|
|
532
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
536
533
|
|
|
537
534
|
### clearField
|
|
538
535
|
|
|
@@ -548,7 +545,7 @@ I.clearField('#email');
|
|
|
548
545
|
|
|
549
546
|
- `field`
|
|
550
547
|
- `editable` **([string][17] | [object][16])** field located by label|name|CSS|XPath|strict locator.
|
|
551
|
-
|
|
548
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder.
|
|
552
549
|
|
|
553
550
|
### click
|
|
554
551
|
|
|
@@ -578,7 +575,7 @@ I.click({css: 'nav a.login'});
|
|
|
578
575
|
|
|
579
576
|
- `locator` **([string][17] | [object][16])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
580
577
|
- `context` **([string][17]? | [object][16] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
581
|
-
|
|
578
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
582
579
|
|
|
583
580
|
|
|
584
581
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -592,7 +589,7 @@ Close current tab.
|
|
|
592
589
|
I.closeCurrentTab();
|
|
593
590
|
```
|
|
594
591
|
|
|
595
|
-
|
|
592
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
596
593
|
|
|
597
594
|
### closeOtherTabs
|
|
598
595
|
|
|
@@ -602,7 +599,7 @@ Close all tabs except for the current one.
|
|
|
602
599
|
I.closeOtherTabs();
|
|
603
600
|
```
|
|
604
601
|
|
|
605
|
-
|
|
602
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
606
603
|
|
|
607
604
|
### defineTimeout
|
|
608
605
|
|
|
@@ -633,7 +630,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
|
|
|
633
630
|
|
|
634
631
|
- `text` **[string][17]** which is not present.
|
|
635
632
|
- `context` **([string][17] | [object][16])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
636
|
-
|
|
633
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
637
634
|
|
|
638
635
|
|
|
639
636
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -652,8 +649,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
|
|
|
652
649
|
#### Parameters
|
|
653
650
|
|
|
654
651
|
- `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
|
|
655
|
-
|
|
656
|
-
Appium: not tested
|
|
652
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested
|
|
657
653
|
|
|
658
654
|
### dontSeeCookie
|
|
659
655
|
|
|
@@ -666,7 +662,7 @@ I.dontSeeCookie('auth'); // no auth cookie
|
|
|
666
662
|
#### Parameters
|
|
667
663
|
|
|
668
664
|
- `name` **[string][17]** cookie name.
|
|
669
|
-
|
|
665
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
670
666
|
|
|
671
667
|
### dontSeeCurrentUrlEquals
|
|
672
668
|
|
|
@@ -681,7 +677,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
|
|
|
681
677
|
#### Parameters
|
|
682
678
|
|
|
683
679
|
- `url` **[string][17]** value to check.
|
|
684
|
-
|
|
680
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
685
681
|
|
|
686
682
|
### dontSeeElement
|
|
687
683
|
|
|
@@ -694,8 +690,7 @@ I.dontSeeElement('.modal'); // modal is not shown
|
|
|
694
690
|
#### Parameters
|
|
695
691
|
|
|
696
692
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|Strict locator.
|
|
697
|
-
|
|
698
|
-
|
|
693
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
699
694
|
|
|
700
695
|
|
|
701
696
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -712,7 +707,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
|
|
|
712
707
|
#### Parameters
|
|
713
708
|
|
|
714
709
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|Strict locator.
|
|
715
|
-
|
|
710
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
716
711
|
|
|
717
712
|
### dontSeeInCurrentUrl
|
|
718
713
|
|
|
@@ -721,7 +716,7 @@ Checks that current url does not contain a provided fragment.
|
|
|
721
716
|
#### Parameters
|
|
722
717
|
|
|
723
718
|
- `url` **[string][17]** value to check.
|
|
724
|
-
|
|
719
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
725
720
|
|
|
726
721
|
### dontSeeInField
|
|
727
722
|
|
|
@@ -737,7 +732,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
|
|
|
737
732
|
|
|
738
733
|
- `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
|
|
739
734
|
- `value` **[string][17]** value to check.
|
|
740
|
-
|
|
735
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
741
736
|
|
|
742
737
|
### dontSeeInSource
|
|
743
738
|
|
|
@@ -751,7 +746,7 @@ I.dontSeeInSource('<!--'); // no comments in source
|
|
|
751
746
|
|
|
752
747
|
- `text`
|
|
753
748
|
- `value` **[string][17]** to check.
|
|
754
|
-
|
|
749
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
755
750
|
|
|
756
751
|
### dontSeeInTitle
|
|
757
752
|
|
|
@@ -764,7 +759,7 @@ I.dontSeeInTitle('Error');
|
|
|
764
759
|
#### Parameters
|
|
765
760
|
|
|
766
761
|
- `text` **[string][17]** value to check.
|
|
767
|
-
|
|
762
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
768
763
|
|
|
769
764
|
### doubleClick
|
|
770
765
|
|
|
@@ -782,7 +777,7 @@ I.doubleClick('.btn.edit');
|
|
|
782
777
|
|
|
783
778
|
- `locator` **([string][17] | [object][16])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
784
779
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
785
|
-
|
|
780
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
786
781
|
|
|
787
782
|
|
|
788
783
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -800,8 +795,7 @@ I.dragAndDrop('#dragHandle', '#container');
|
|
|
800
795
|
|
|
801
796
|
- `srcElement` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
802
797
|
- `destElement` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
803
|
-
|
|
804
|
-
Appium: not tested
|
|
798
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested
|
|
805
799
|
|
|
806
800
|
### dragSlider
|
|
807
801
|
|
|
@@ -817,7 +811,7 @@ I.dragSlider('#slider', -70);
|
|
|
817
811
|
|
|
818
812
|
- `locator` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
|
|
819
813
|
- `offsetX` **[number][20]** position to drag.
|
|
820
|
-
|
|
814
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
821
815
|
|
|
822
816
|
### executeAsyncScript
|
|
823
817
|
|
|
@@ -845,7 +839,7 @@ let val = await I.executeAsyncScript(function(url, done) {
|
|
|
845
839
|
#### Parameters
|
|
846
840
|
|
|
847
841
|
- `args` **...any** to be passed to function.
|
|
848
|
-
|
|
842
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
849
843
|
- `fn` **([string][17] | [function][22])** function to be executed in browser context.
|
|
850
844
|
|
|
851
845
|
### executeScript
|
|
@@ -877,7 +871,7 @@ let date = await I.executeScript(function(el) {
|
|
|
877
871
|
#### Parameters
|
|
878
872
|
|
|
879
873
|
- `args` **...any** to be passed to function.
|
|
880
|
-
|
|
874
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderWraps [execute][23] command.
|
|
881
875
|
- `fn` **([string][17] | [function][22])** function to be executed in browser context.
|
|
882
876
|
|
|
883
877
|
### fillField
|
|
@@ -900,8 +894,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
|
|
|
900
894
|
|
|
901
895
|
- `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
|
|
902
896
|
- `value` **([string][17] | [object][16])** text value to fill.
|
|
903
|
-
|
|
904
|
-
|
|
897
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
905
898
|
|
|
906
899
|
|
|
907
900
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -939,7 +932,7 @@ I.forceClick({css: 'nav a.login'});
|
|
|
939
932
|
|
|
940
933
|
- `locator` **([string][17] | [object][16])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
941
934
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
942
|
-
|
|
935
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
943
936
|
|
|
944
937
|
|
|
945
938
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -966,7 +959,7 @@ I.forceRightClick('Menu');
|
|
|
966
959
|
|
|
967
960
|
- `locator` **([string][17] | [object][16])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
|
|
968
961
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
969
|
-
|
|
962
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
970
963
|
|
|
971
964
|
|
|
972
965
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -1322,7 +1315,7 @@ I.moveCursorTo('#submit', 5,5);
|
|
|
1322
1315
|
- `yOffset`
|
|
1323
1316
|
- `offsetX` **[number][20]** (optional, `0` by default) X-axis offset.
|
|
1324
1317
|
- `offsetY` **[number][20]** (optional, `0` by default) Y-axis offset.
|
|
1325
|
-
|
|
1318
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1326
1319
|
|
|
1327
1320
|
### openNewTab
|
|
1328
1321
|
|
|
@@ -1332,7 +1325,7 @@ Open new tab and switch to it.
|
|
|
1332
1325
|
I.openNewTab();
|
|
1333
1326
|
```
|
|
1334
1327
|
|
|
1335
|
-
|
|
1328
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1336
1329
|
|
|
1337
1330
|
#### Parameters
|
|
1338
1331
|
|
|
@@ -1403,7 +1396,7 @@ Some of the supported key names are:
|
|
|
1403
1396
|
#### Parameters
|
|
1404
1397
|
|
|
1405
1398
|
- `key` **([string][17] | [Array][25]<[string][17]>)** key or array of keys to press.
|
|
1406
|
-
|
|
1399
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder_Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
|
|
1407
1400
|
|
|
1408
1401
|
### pressKeyDown
|
|
1409
1402
|
|
|
@@ -1420,7 +1413,7 @@ I.pressKeyUp('Control');
|
|
|
1420
1413
|
#### Parameters
|
|
1421
1414
|
|
|
1422
1415
|
- `key` **[string][17]** name of key to press down.
|
|
1423
|
-
|
|
1416
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1424
1417
|
|
|
1425
1418
|
### pressKeyUp
|
|
1426
1419
|
|
|
@@ -1437,7 +1430,7 @@ I.pressKeyUp('Control');
|
|
|
1437
1430
|
#### Parameters
|
|
1438
1431
|
|
|
1439
1432
|
- `key` **[string][17]** name of key to release.
|
|
1440
|
-
|
|
1433
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1441
1434
|
|
|
1442
1435
|
### refreshPage
|
|
1443
1436
|
|
|
@@ -1447,7 +1440,7 @@ Reload the current page.
|
|
|
1447
1440
|
I.refreshPage();
|
|
1448
1441
|
```
|
|
1449
1442
|
|
|
1450
|
-
|
|
1443
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1451
1444
|
|
|
1452
1445
|
### resizeWindow
|
|
1453
1446
|
|
|
@@ -1458,8 +1451,7 @@ First parameter can be set to `maximize`.
|
|
|
1458
1451
|
|
|
1459
1452
|
- `width` **[number][20]** width in pixels or `maximize`.
|
|
1460
1453
|
- `height` **[number][20]** height in pixels.
|
|
1461
|
-
|
|
1462
|
-
Appium: not tested in web, in apps doesn't work
|
|
1454
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested in web, in apps doesn't work
|
|
1463
1455
|
|
|
1464
1456
|
### rightClick
|
|
1465
1457
|
|
|
@@ -1478,7 +1470,7 @@ I.rightClick('Click me', '.context');
|
|
|
1478
1470
|
|
|
1479
1471
|
- `locator` **([string][17] | [object][16])** clickable element located by CSS|XPath|strict locator.
|
|
1480
1472
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
1481
|
-
|
|
1473
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1482
1474
|
|
|
1483
1475
|
|
|
1484
1476
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -1512,7 +1504,7 @@ Placeholder for ~ locator only test case write once run on both Appium and WebDr
|
|
|
1512
1504
|
|
|
1513
1505
|
### saveElementScreenshot
|
|
1514
1506
|
|
|
1515
|
-
Saves screenshot of the specified locator to ouput folder (set in codecept.
|
|
1507
|
+
Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
1516
1508
|
Filename is relative to output folder.
|
|
1517
1509
|
|
|
1518
1510
|
```js
|
|
@@ -1523,11 +1515,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
|
|
|
1523
1515
|
|
|
1524
1516
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
1525
1517
|
- `fileName` **[string][17]** file name to save.
|
|
1526
|
-
|
|
1518
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1527
1519
|
|
|
1528
1520
|
### saveScreenshot
|
|
1529
1521
|
|
|
1530
|
-
Saves a screenshot to ouput folder (set in codecept.
|
|
1522
|
+
Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
1531
1523
|
Filename is relative to output folder.
|
|
1532
1524
|
Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
|
|
1533
1525
|
|
|
@@ -1540,7 +1532,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
|
|
|
1540
1532
|
|
|
1541
1533
|
- `fileName` **[string][17]** file name to save.
|
|
1542
1534
|
- `fullPage` **[boolean][29]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
1543
|
-
|
|
1535
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1544
1536
|
|
|
1545
1537
|
### scrollIntoView
|
|
1546
1538
|
|
|
@@ -1556,7 +1548,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
|
|
|
1556
1548
|
|
|
1557
1549
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
1558
1550
|
- `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][30].
|
|
1559
|
-
|
|
1551
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1560
1552
|
|
|
1561
1553
|
### scrollPageToBottom
|
|
1562
1554
|
|
|
@@ -1566,7 +1558,7 @@ Scroll page to the bottom.
|
|
|
1566
1558
|
I.scrollPageToBottom();
|
|
1567
1559
|
```
|
|
1568
1560
|
|
|
1569
|
-
|
|
1561
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1570
1562
|
|
|
1571
1563
|
### scrollPageToTop
|
|
1572
1564
|
|
|
@@ -1576,7 +1568,7 @@ Scroll page to the top.
|
|
|
1576
1568
|
I.scrollPageToTop();
|
|
1577
1569
|
```
|
|
1578
1570
|
|
|
1579
|
-
|
|
1571
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1580
1572
|
|
|
1581
1573
|
### scrollTo
|
|
1582
1574
|
|
|
@@ -1593,7 +1585,7 @@ I.scrollTo('#submit', 5, 5);
|
|
|
1593
1585
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
1594
1586
|
- `offsetX` **[number][20]** (optional, `0` by default) X-axis offset.
|
|
1595
1587
|
- `offsetY` **[number][20]** (optional, `0` by default) Y-axis offset.
|
|
1596
|
-
|
|
1588
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1597
1589
|
|
|
1598
1590
|
### see
|
|
1599
1591
|
|
|
@@ -1610,7 +1602,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
|
|
|
1610
1602
|
|
|
1611
1603
|
- `text` **[string][17]** expected on page.
|
|
1612
1604
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
1613
|
-
|
|
1605
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1614
1606
|
|
|
1615
1607
|
|
|
1616
1608
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -1628,7 +1620,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
|
|
|
1628
1620
|
|
|
1629
1621
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
1630
1622
|
- `attributes` **[object][16]** attributes and their values to check.
|
|
1631
|
-
|
|
1623
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1632
1624
|
|
|
1633
1625
|
### seeCheckboxIsChecked
|
|
1634
1626
|
|
|
@@ -1643,8 +1635,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
|
|
|
1643
1635
|
#### Parameters
|
|
1644
1636
|
|
|
1645
1637
|
- `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
|
|
1646
|
-
|
|
1647
|
-
Appium: not tested
|
|
1638
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested
|
|
1648
1639
|
|
|
1649
1640
|
### seeCookie
|
|
1650
1641
|
|
|
@@ -1657,7 +1648,7 @@ I.seeCookie('Auth');
|
|
|
1657
1648
|
#### Parameters
|
|
1658
1649
|
|
|
1659
1650
|
- `name` **[string][17]** cookie name.
|
|
1660
|
-
|
|
1651
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1661
1652
|
|
|
1662
1653
|
### seeCssPropertiesOnElements
|
|
1663
1654
|
|
|
@@ -1671,7 +1662,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
|
|
|
1671
1662
|
|
|
1672
1663
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
1673
1664
|
- `cssProperties` **[object][16]** object with CSS properties and their values to check.
|
|
1674
|
-
|
|
1665
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1675
1666
|
|
|
1676
1667
|
### seeCurrentUrlEquals
|
|
1677
1668
|
|
|
@@ -1687,7 +1678,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
|
|
|
1687
1678
|
#### Parameters
|
|
1688
1679
|
|
|
1689
1680
|
- `url` **[string][17]** value to check.
|
|
1690
|
-
|
|
1681
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1691
1682
|
|
|
1692
1683
|
### seeElement
|
|
1693
1684
|
|
|
@@ -1701,8 +1692,7 @@ I.seeElement('#modal');
|
|
|
1701
1692
|
#### Parameters
|
|
1702
1693
|
|
|
1703
1694
|
- `locator` **([string][17] | [object][16])** located by CSS|XPath|strict locator.
|
|
1704
|
-
|
|
1705
|
-
|
|
1695
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1706
1696
|
|
|
1707
1697
|
|
|
1708
1698
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -1720,7 +1710,7 @@ I.seeElementInDOM('#modal');
|
|
|
1720
1710
|
#### Parameters
|
|
1721
1711
|
|
|
1722
1712
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
1723
|
-
|
|
1713
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1724
1714
|
|
|
1725
1715
|
### seeInCurrentUrl
|
|
1726
1716
|
|
|
@@ -1733,7 +1723,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
|
|
|
1733
1723
|
#### Parameters
|
|
1734
1724
|
|
|
1735
1725
|
- `url` **[string][17]** a fragment to check
|
|
1736
|
-
|
|
1726
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1737
1727
|
|
|
1738
1728
|
### seeInField
|
|
1739
1729
|
|
|
@@ -1751,7 +1741,7 @@ I.seeInField('#searchform input','Search');
|
|
|
1751
1741
|
|
|
1752
1742
|
- `field` **([string][17] | [object][16])** located by label|name|CSS|XPath|strict locator.
|
|
1753
1743
|
- `value` **[string][17]** value to check.
|
|
1754
|
-
|
|
1744
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1755
1745
|
|
|
1756
1746
|
### seeInPopup
|
|
1757
1747
|
|
|
@@ -1773,7 +1763,7 @@ I.seeInSource('<h1>Green eggs & ham</h1>');
|
|
|
1773
1763
|
#### Parameters
|
|
1774
1764
|
|
|
1775
1765
|
- `text` **[string][17]** value to check.
|
|
1776
|
-
|
|
1766
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1777
1767
|
|
|
1778
1768
|
### seeInTitle
|
|
1779
1769
|
|
|
@@ -1786,7 +1776,7 @@ I.seeInTitle('Home Page');
|
|
|
1786
1776
|
#### Parameters
|
|
1787
1777
|
|
|
1788
1778
|
- `text` **[string][17]** text value to check.
|
|
1789
|
-
|
|
1779
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1790
1780
|
|
|
1791
1781
|
### seeNumberOfElements
|
|
1792
1782
|
|
|
@@ -1801,8 +1791,7 @@ I.seeNumberOfElements('#submitBtn', 1);
|
|
|
1801
1791
|
|
|
1802
1792
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
1803
1793
|
- `num` **[number][20]** number of elements.
|
|
1804
|
-
|
|
1805
|
-
|
|
1794
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1806
1795
|
|
|
1807
1796
|
|
|
1808
1797
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -1821,8 +1810,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
|
|
|
1821
1810
|
|
|
1822
1811
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
1823
1812
|
- `num` **[number][20]** number of elements.
|
|
1824
|
-
|
|
1825
|
-
|
|
1813
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1826
1814
|
|
|
1827
1815
|
|
|
1828
1816
|
This action supports [React locators](https://codecept.io/react#locators)
|
|
@@ -1840,7 +1828,7 @@ I.seeTextEquals('text', 'h1');
|
|
|
1840
1828
|
|
|
1841
1829
|
- `text` **[string][17]** element value to check.
|
|
1842
1830
|
- `context` **([string][17] | [object][16])?** element located by CSS|XPath|strict locator.
|
|
1843
|
-
|
|
1831
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1844
1832
|
|
|
1845
1833
|
### seeTitleEquals
|
|
1846
1834
|
|
|
@@ -1853,7 +1841,7 @@ I.seeTitleEquals('Test title.');
|
|
|
1853
1841
|
#### Parameters
|
|
1854
1842
|
|
|
1855
1843
|
- `text` **[string][17]** value to check.
|
|
1856
|
-
|
|
1844
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1857
1845
|
|
|
1858
1846
|
### selectOption
|
|
1859
1847
|
|
|
@@ -1880,7 +1868,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
|
|
|
1880
1868
|
|
|
1881
1869
|
- `select` **([string][17] | [object][16])** field located by label|name|CSS|XPath|strict locator.
|
|
1882
1870
|
- `option` **([string][17] | [Array][25]<any>)** visible text or value of option.
|
|
1883
|
-
|
|
1871
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1884
1872
|
|
|
1885
1873
|
### setCookie
|
|
1886
1874
|
|
|
@@ -1901,7 +1889,7 @@ I.setCookie([
|
|
|
1901
1889
|
#### Parameters
|
|
1902
1890
|
|
|
1903
1891
|
- `cookie` **(Cookie | [Array][25]<Cookie>)** a cookie object or array of cookie objects.
|
|
1904
|
-
|
|
1892
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderUses Selenium's JSON [cookie
|
|
1905
1893
|
format][31].
|
|
1906
1894
|
|
|
1907
1895
|
### setGeoLocation
|
|
@@ -1918,7 +1906,7 @@ I.setGeoLocation(121.21, 11.56, 10);
|
|
|
1918
1906
|
- `latitude` **[number][20]** to set.
|
|
1919
1907
|
- `longitude` **[number][20]** to set
|
|
1920
1908
|
- `altitude` **[number][20]?** (optional, null by default) to set
|
|
1921
|
-
|
|
1909
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1922
1910
|
|
|
1923
1911
|
### switchTo
|
|
1924
1912
|
|
|
@@ -1932,7 +1920,7 @@ I.switchTo(); // switch back to main page
|
|
|
1932
1920
|
#### Parameters
|
|
1933
1921
|
|
|
1934
1922
|
- `locator` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
1935
|
-
|
|
1923
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1936
1924
|
|
|
1937
1925
|
### switchToNextTab
|
|
1938
1926
|
|
|
@@ -1947,7 +1935,7 @@ I.switchToNextTab(2);
|
|
|
1947
1935
|
|
|
1948
1936
|
- `num` **[number][20]?** (optional) number of tabs to switch forward, default: 1.
|
|
1949
1937
|
- `sec` **([number][20] | null)?** (optional) time in seconds to wait.
|
|
1950
|
-
|
|
1938
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1951
1939
|
|
|
1952
1940
|
### switchToPreviousTab
|
|
1953
1941
|
|
|
@@ -1962,7 +1950,7 @@ I.switchToPreviousTab(2);
|
|
|
1962
1950
|
|
|
1963
1951
|
- `num` **[number][20]?** (optional) number of tabs to switch backward, default: 1.
|
|
1964
1952
|
- `sec` **[number][20]??** (optional) time in seconds to wait.
|
|
1965
|
-
|
|
1953
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
1966
1954
|
|
|
1967
1955
|
### switchToWindow
|
|
1968
1956
|
|
|
@@ -2003,7 +1991,7 @@ I.type(['T', 'E', 'X', 'T']);
|
|
|
2003
1991
|
|
|
2004
1992
|
- `keys`
|
|
2005
1993
|
- `delay` **[number][20]?** (optional) delay in ms between key presses
|
|
2006
|
-
|
|
1994
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2007
1995
|
- `key` **([string][17] | [Array][25]<[string][17]>)** or array of keys to type.
|
|
2008
1996
|
|
|
2009
1997
|
### uncheckOption
|
|
@@ -2023,8 +2011,7 @@ I.uncheckOption('agree', '//form');
|
|
|
2023
2011
|
|
|
2024
2012
|
- `field` **([string][17] | [object][16])** checkbox located by label | name | CSS | XPath | strict locator.
|
|
2025
2013
|
- `context` **([string][17]? | [object][16])** (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2026
|
-
|
|
2027
|
-
Appium: not tested
|
|
2014
|
+
⚠️ returns a _promise_ which is synchronized internally by recorderAppium: not tested
|
|
2028
2015
|
|
|
2029
2016
|
### useWebDriverTo
|
|
2030
2017
|
|
|
@@ -2058,7 +2045,7 @@ I.wait(2); // wait 2 secs
|
|
|
2058
2045
|
#### Parameters
|
|
2059
2046
|
|
|
2060
2047
|
- `sec` **[number][20]** number of second to wait.
|
|
2061
|
-
|
|
2048
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2062
2049
|
|
|
2063
2050
|
### waitForClickable
|
|
2064
2051
|
|
|
@@ -2075,7 +2062,7 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
|
|
|
2075
2062
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2076
2063
|
- `waitTimeout`
|
|
2077
2064
|
- `sec` **[number][20]?** (optional, `1` by default) time in seconds to wait
|
|
2078
|
-
|
|
2065
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2079
2066
|
|
|
2080
2067
|
### waitForDetached
|
|
2081
2068
|
|
|
@@ -2090,7 +2077,7 @@ I.waitForDetached('#popup');
|
|
|
2090
2077
|
|
|
2091
2078
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2092
2079
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2093
|
-
|
|
2080
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2094
2081
|
|
|
2095
2082
|
### waitForElement
|
|
2096
2083
|
|
|
@@ -2106,7 +2093,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
|
|
|
2106
2093
|
|
|
2107
2094
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2108
2095
|
- `sec` **[number][20]?** (optional, `1` by default) time in seconds to wait
|
|
2109
|
-
|
|
2096
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2110
2097
|
|
|
2111
2098
|
### waitForEnabled
|
|
2112
2099
|
|
|
@@ -2117,7 +2104,7 @@ Element can be located by CSS or XPath.
|
|
|
2117
2104
|
|
|
2118
2105
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2119
2106
|
- `sec` **[number][20]** (optional) time in seconds to wait, 1 by default.
|
|
2120
|
-
|
|
2107
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2121
2108
|
|
|
2122
2109
|
### waitForFunction
|
|
2123
2110
|
|
|
@@ -2139,7 +2126,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
|
|
|
2139
2126
|
- `fn` **([string][17] | [function][22])** to be executed in browser context.
|
|
2140
2127
|
- `argsOrSec` **([Array][25]<any> | [number][20])?** (optional, `1` by default) arguments for function or seconds.
|
|
2141
2128
|
- `sec` **[number][20]?** (optional, `1` by default) time in seconds to wait
|
|
2142
|
-
|
|
2129
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2143
2130
|
|
|
2144
2131
|
### waitForInvisible
|
|
2145
2132
|
|
|
@@ -2154,7 +2141,7 @@ I.waitForInvisible('#popup');
|
|
|
2154
2141
|
|
|
2155
2142
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2156
2143
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2157
|
-
|
|
2144
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2158
2145
|
|
|
2159
2146
|
### waitForText
|
|
2160
2147
|
|
|
@@ -2172,7 +2159,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
|
|
|
2172
2159
|
- `text` **[string][17]** to wait for.
|
|
2173
2160
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2174
2161
|
- `context` **([string][17] | [object][16])?** (optional) element located by CSS|XPath|strict locator.
|
|
2175
|
-
|
|
2162
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2176
2163
|
|
|
2177
2164
|
### waitForValue
|
|
2178
2165
|
|
|
@@ -2187,7 +2174,7 @@ I.waitForValue('//input', "GoodValue");
|
|
|
2187
2174
|
- `field` **([string][17] | [object][16])** input field.
|
|
2188
2175
|
- `value` **[string][17]** expected value.
|
|
2189
2176
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2190
|
-
|
|
2177
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2191
2178
|
|
|
2192
2179
|
### waitForVisible
|
|
2193
2180
|
|
|
@@ -2202,7 +2189,7 @@ I.waitForVisible('#popup');
|
|
|
2202
2189
|
|
|
2203
2190
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2204
2191
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2205
|
-
|
|
2192
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2206
2193
|
|
|
2207
2194
|
### waitInUrl
|
|
2208
2195
|
|
|
@@ -2216,7 +2203,7 @@ I.waitInUrl('/info', 2);
|
|
|
2216
2203
|
|
|
2217
2204
|
- `urlPart` **[string][17]** value to check.
|
|
2218
2205
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2219
|
-
|
|
2206
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2220
2207
|
|
|
2221
2208
|
### waitNumberOfVisibleElements
|
|
2222
2209
|
|
|
@@ -2231,7 +2218,7 @@ I.waitNumberOfVisibleElements('a', 3);
|
|
|
2231
2218
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2232
2219
|
- `num` **[number][20]** number of elements.
|
|
2233
2220
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2234
|
-
|
|
2221
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2235
2222
|
|
|
2236
2223
|
### waitToHide
|
|
2237
2224
|
|
|
@@ -2246,7 +2233,7 @@ I.waitToHide('#popup');
|
|
|
2246
2233
|
|
|
2247
2234
|
- `locator` **([string][17] | [object][16])** element located by CSS|XPath|strict locator.
|
|
2248
2235
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2249
|
-
|
|
2236
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2250
2237
|
|
|
2251
2238
|
### waitUrlEquals
|
|
2252
2239
|
|
|
@@ -2261,7 +2248,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
|
|
|
2261
2248
|
|
|
2262
2249
|
- `urlPart` **[string][17]** value to check.
|
|
2263
2250
|
- `sec` **[number][20]** (optional, `1` by default) time in seconds to wait
|
|
2264
|
-
|
|
2251
|
+
⚠️ returns a _promise_ which is synchronized internally by recorder
|
|
2265
2252
|
|
|
2266
2253
|
: http://webdriver.io/
|
|
2267
2254
|
|