codeceptjs 4.2.2 → 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.
Files changed (74) hide show
  1. package/README.md +4 -4
  2. package/docs/ai.md +1 -1
  3. package/docs/alternative-browsers.md +4 -4
  4. package/docs/api.md +13 -13
  5. package/docs/assertions.md +6 -6
  6. package/docs/best.md +1 -1
  7. package/docs/bootstrap.md +1 -1
  8. package/docs/data.md +8 -8
  9. package/docs/element-selection.md +27 -4
  10. package/docs/helpers/ApiDataFactory.md +2 -2
  11. package/docs/helpers/Appium.md +56 -56
  12. package/docs/helpers/Decision.md +1 -1
  13. package/docs/helpers/Detox.md +1 -1
  14. package/docs/helpers/ExpectHelper.md +1 -1
  15. package/docs/helpers/FileSystem.md +1 -1
  16. package/docs/helpers/GraphQL.md +1 -1
  17. package/docs/helpers/GraphQLDataFactory.md +2 -2
  18. package/docs/helpers/JSONResponse.md +1 -1
  19. package/docs/helpers/Kitesurf.md +65 -65
  20. package/docs/helpers/Lightpanda.md +65 -65
  21. package/docs/helpers/MockRequest.md +1 -1
  22. package/docs/helpers/Moli.md +65 -65
  23. package/docs/helpers/Obscura.md +65 -65
  24. package/docs/helpers/Playwright.md +127 -127
  25. package/docs/helpers/Puppeteer.md +88 -88
  26. package/docs/helpers/REST.md +1 -1
  27. package/docs/helpers/WebDriver.md +87 -87
  28. package/docs/installation.md +1 -1
  29. package/docs/locators.md +5 -7
  30. package/docs/migration-4.md +7 -3
  31. package/docs/mobile.md +2 -2
  32. package/docs/parallel.md +1 -1
  33. package/docs/playwright.md +5 -5
  34. package/docs/plugins/aiTrace.md +1 -1
  35. package/docs/plugins/autoDelay.md +1 -1
  36. package/docs/plugins/customLocator.md +1 -1
  37. package/docs/plugins/customReporter.md +1 -1
  38. package/docs/plugins/junitReporter.md +2 -2
  39. package/docs/plugins/pageInfo.md +1 -1
  40. package/docs/plugins/pauseOnFail.md +1 -1
  41. package/docs/plugins/retryFailedStep.md +1 -1
  42. package/docs/plugins/screenshotOnFail.md +1 -1
  43. package/docs/plugins/stepTimeout.md +1 -1
  44. package/docs/plugins.md +10 -10
  45. package/docs/puppeteer.md +4 -4
  46. package/docs/retry.md +1 -1
  47. package/docs/timeouts.md +7 -7
  48. package/docs/webdriver.md +8 -8
  49. package/lib/actor.js +20 -2
  50. package/lib/aria.js +1 -0
  51. package/lib/codecept.js +1 -1
  52. package/lib/data/context.js +24 -0
  53. package/lib/element/WebElement.js +5 -5
  54. package/lib/helper/ApiDataFactory.js +1 -1
  55. package/lib/helper/Appium.js +2 -2
  56. package/lib/helper/GraphQLDataFactory.js +1 -1
  57. package/lib/helper/Playwright.js +22 -12
  58. package/lib/helper/Puppeteer.js +5 -11
  59. package/lib/mocha/asyncWrapper.js +14 -3
  60. package/lib/mocha/test.js +1 -0
  61. package/lib/plugin/auth.js +3 -0
  62. package/lib/plugin/junitReporter.js +21 -12
  63. package/lib/recorder.js +22 -3
  64. package/lib/step/base.js +8 -1
  65. package/lib/step/func.js +1 -1
  66. package/lib/step/helper.js +1 -1
  67. package/lib/step/record.js +22 -17
  68. package/lib/step/retry.js +13 -6
  69. package/lib/utils/typescript.js +86 -12
  70. package/lib/workers.js +15 -0
  71. package/package.json +2 -1
  72. package/typings/index.d.ts +12 -0
  73. package/typings/promiseBasedTypes.d.ts +696 -351
  74. package/typings/types.d.ts +485 -352
@@ -1,5 +1,5 @@
1
1
  ---
2
- permalink: /helpers/WebDriver
2
+ permalink: /helpers/web-driver
3
3
  editLink: false
4
4
  sidebar: auto
5
5
  title: WebDriver
@@ -433,7 +433,7 @@ I.amOnPage('/login'); // opens a login page
433
433
 
434
434
  * `url` **[string][18]** url path or global url.
435
435
 
436
- Returns **void** automatically synchronized promise through #recorder
436
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
437
437
 
438
438
  ### appendField
439
439
 
@@ -456,7 +456,7 @@ I.appendField('name', 'John', '.form-container');
456
456
  * `value` **[string][18]** text value to append.
457
457
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
458
458
 
459
- Returns **void** automatically synchronized promise through #recorder
459
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
460
460
 
461
461
  ### attachFile
462
462
 
@@ -488,7 +488,7 @@ I.attachFile('#dropzone', 'data/avatar.jpg');
488
488
  * `pathToFile` **[string][18]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
489
489
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
490
490
 
491
- Returns **void** automatically synchronized promise through #recorder
491
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
492
492
 
493
493
  ### blur
494
494
 
@@ -513,7 +513,7 @@ I.dontSee('#add-to-cart-btn');
513
513
  * `locator` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
514
514
  * `options` **any?** Playwright only: [Additional options][21] for available options object as 2nd argument.
515
515
 
516
- Returns **void** automatically synchronized promise through #recorder
516
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
517
517
 
518
518
  ### cancelPopup
519
519
 
@@ -542,7 +542,7 @@ I.checkOption('agree', '//form');
542
542
  * `field` **([string][18] | [object][19])** checkbox located by label | name | CSS | XPath | strict locator.
543
543
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
544
544
 
545
- Returns **void** automatically synchronized promise through #recorder
545
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
546
546
 
547
547
  ### clearClipboard
548
548
 
@@ -553,7 +553,7 @@ I.clearClipboard();
553
553
  I.seeClipboardEquals('');
554
554
  ```
555
555
 
556
- Returns **void** automatically synchronized promise through #recorder
556
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
557
557
 
558
558
  ### clearCookie
559
559
 
@@ -589,7 +589,7 @@ I.clearField('Email', '.form-container');
589
589
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
590
590
  * `editable` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
591
591
 
592
- Returns **void** automatically synchronized promise through #recorder.
592
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder.
593
593
 
594
594
  ### click
595
595
 
@@ -628,7 +628,7 @@ I.click({role: 'button', name: 'Submit'});
628
628
  * `locator` **([string][18] | [object][19])** (optional, `'//body'` by default) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
629
629
  * `context` **([string][18]? | [object][19] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
630
630
 
631
- Returns **void** automatically synchronized promise through #recorder
631
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
632
632
 
633
633
  ### clickXY
634
634
 
@@ -660,7 +660,7 @@ Close current tab.
660
660
  I.closeCurrentTab();
661
661
  ```
662
662
 
663
- Returns **void** automatically synchronized promise through #recorder
663
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
664
664
 
665
665
  ### closeOtherTabs
666
666
 
@@ -670,7 +670,7 @@ Close all tabs except for the current one.
670
670
  I.closeOtherTabs();
671
671
  ```
672
672
 
673
- Returns **void** automatically synchronized promise through #recorder
673
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
674
674
 
675
675
  ### defineTimeout
676
676
 
@@ -702,7 +702,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
702
702
  * `text` **[string][18]** which is not present.
703
703
  * `context` **([string][18] | [object][19])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
704
704
 
705
- Returns **void** automatically synchronized promise through #recorder
705
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
706
706
 
707
707
  ### dontSeeCheckboxIsChecked
708
708
 
@@ -719,7 +719,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
719
719
 
720
720
  * `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
721
721
 
722
- Returns **void** automatically synchronized promise through #recorder
722
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
723
723
 
724
724
  ### dontSeeCookie
725
725
 
@@ -733,7 +733,7 @@ I.dontSeeCookie('auth'); // no auth cookie
733
733
 
734
734
  * `name` **[string][18]** cookie name.
735
735
 
736
- Returns **void** automatically synchronized promise through #recorder
736
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
737
737
 
738
738
  ### dontSeeCurrentPathEquals
739
739
 
@@ -749,7 +749,7 @@ I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
749
749
 
750
750
  * `path` **[string][18]** value to check.
751
751
 
752
- Returns **void** automatically synchronized promise through #recorder
752
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
753
753
 
754
754
  ### dontSeeCurrentUrlEquals
755
755
 
@@ -765,7 +765,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
765
765
 
766
766
  * `url` **[string][18]** value to check.
767
767
 
768
- Returns **void** automatically synchronized promise through #recorder
768
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
769
769
 
770
770
  ### dontSeeElement
771
771
 
@@ -783,7 +783,7 @@ I.dontSeeElement('.modal', '#container');
783
783
  * `locator` **([string][18] | [object][19])** located by CSS|XPath|Strict locator.
784
784
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
785
785
 
786
- Returns **void** automatically synchronized promise through #recorder
786
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
787
787
 
788
788
  ### dontSeeElementInDOM
789
789
 
@@ -797,7 +797,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
797
797
 
798
798
  * `locator` **([string][18] | [object][19])** located by CSS|XPath|Strict locator.
799
799
 
800
- Returns **void** automatically synchronized promise through #recorder
800
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
801
801
 
802
802
  ### dontSeeInCurrentUrl
803
803
 
@@ -807,7 +807,7 @@ Checks that current url does not contain a provided fragment.
807
807
 
808
808
  * `url` **[string][18]** value to check.
809
809
 
810
- Returns **void** automatically synchronized promise through #recorder
810
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
811
811
 
812
812
  ### dontSeeInField
813
813
 
@@ -829,7 +829,7 @@ I.dontSeeInField('Name', 'old_value', '.form-container');
829
829
  * `value` **([string][18] | [object][19])** value to check.
830
830
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
831
831
 
832
- Returns **void** automatically synchronized promise through #recorder
832
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
833
833
 
834
834
  ### dontSeeInSource
835
835
 
@@ -844,7 +844,7 @@ I.dontSeeInSource('<!--'); // no comments in source
844
844
  * `text` &#x20;
845
845
  * `value` **[string][18]** to check.
846
846
 
847
- Returns **void** automatically synchronized promise through #recorder
847
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
848
848
 
849
849
  ### dontSeeInTitle
850
850
 
@@ -858,7 +858,7 @@ I.dontSeeInTitle('Error');
858
858
 
859
859
  * `text` **[string][18]** value to check.
860
860
 
861
- Returns **void** automatically synchronized promise through #recorder
861
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
862
862
 
863
863
  ### doubleClick
864
864
 
@@ -877,7 +877,7 @@ I.doubleClick('.btn.edit');
877
877
  * `locator` **([string][18] | [object][19])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
878
878
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
879
879
 
880
- Returns **void** automatically synchronized promise through #recorder
880
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
881
881
 
882
882
  ### dragAndDrop
883
883
 
@@ -893,7 +893,7 @@ I.dragAndDrop('#dragHandle', '#container');
893
893
  * `srcElement` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
894
894
  * `destElement` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
895
895
 
896
- Returns **void** automatically synchronized promise through #recorder
896
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
897
897
 
898
898
  ### dragSlider
899
899
 
@@ -910,7 +910,7 @@ I.dragSlider('#slider', -70);
910
910
  * `locator` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
911
911
  * `offsetX` **[number][23]** position to drag.
912
912
 
913
- Returns **void** automatically synchronized promise through #recorder
913
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
914
914
 
915
915
  ### executeAsyncScript
916
916
 
@@ -1007,7 +1007,7 @@ I.fillField('Name', 'John', '#section2');
1007
1007
  * `value` **([string][18] | [object][19])** text value to fill.
1008
1008
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1009
1009
 
1010
- Returns **void** automatically synchronized promise through #recorder{{ custom }}
1010
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder{{ custom }}
1011
1011
 
1012
1012
  ### focus
1013
1013
 
@@ -1026,7 +1026,7 @@ I.see('#add-to-cart-bnt');
1026
1026
  * `locator` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
1027
1027
  * `options` **any?** Playwright only: [Additional options][29] for available options object as 2nd argument.
1028
1028
 
1029
- Returns **void** automatically synchronized promise through #recorder
1029
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1030
1030
 
1031
1031
  ### forceClick
1032
1032
 
@@ -1060,7 +1060,7 @@ I.forceClick({css: 'nav a.login'});
1060
1060
  * `locator` **([string][18] | [object][19])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1061
1061
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
1062
1062
 
1063
- Returns **void** automatically synchronized promise through #recorder
1063
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1064
1064
 
1065
1065
  ### forceRightClick
1066
1066
 
@@ -1084,7 +1084,7 @@ I.forceRightClick('Menu');
1084
1084
  * `locator` **([string][18] | [object][19])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
1085
1085
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
1086
1086
 
1087
- Returns **void** automatically synchronized promise through #recorder
1087
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1088
1088
 
1089
1089
  ### grabAllWindowHandles
1090
1090
 
@@ -1436,7 +1436,7 @@ const webElement = await I.grabWebElement('#button');
1436
1436
 
1437
1437
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
1438
1438
 
1439
- Returns **[Promise][24]<any>** WebElement of being used Web helper
1439
+ Returns **[Promise][24]<CodeceptJS.WebElement>** WebElement of being used Web helper
1440
1440
 
1441
1441
  ### grabWebElements
1442
1442
 
@@ -1451,7 +1451,7 @@ const webElements = await I.grabWebElements('#button');
1451
1451
 
1452
1452
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
1453
1453
 
1454
- Returns **[Promise][24]<any>** WebElement of being used Web helper
1454
+ Returns **[Promise][24]<[Array][30]<CodeceptJS.WebElement>>** WebElements of being used Web helper
1455
1455
 
1456
1456
  ### moveCursorTo
1457
1457
 
@@ -1475,7 +1475,7 @@ I.moveCursorTo('#submit', '.container');
1475
1475
  * `offsetX` **([number][23] | [string][18] | [object][19])** (optional, `0` by default) X-axis offset or context locator.
1476
1476
  * `offsetY` **[number][23]** (optional, `0` by default) Y-axis offset.
1477
1477
 
1478
- Returns **void** automatically synchronized promise through #recorder
1478
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1479
1479
 
1480
1480
  ### openNewTab
1481
1481
 
@@ -1490,7 +1490,7 @@ I.openNewTab();
1490
1490
  * `url`
1491
1491
  * `windowName`
1492
1492
 
1493
- Returns **void** automatically synchronized promise through #recorder
1493
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1494
1494
 
1495
1495
  ### pressKey
1496
1496
 
@@ -1559,7 +1559,7 @@ Some of the supported key names are:
1559
1559
 
1560
1560
  * `key` **([string][18] | [Array][30]<[string][18]>)** key or array of keys to press.
1561
1561
 
1562
- Returns **void** automatically synchronized promise through #recorder
1562
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1563
1563
 
1564
1564
  ### pressKeyDown
1565
1565
 
@@ -1577,7 +1577,7 @@ I.pressKeyUp('Control');
1577
1577
 
1578
1578
  * `key` **[string][18]** name of key to press down.
1579
1579
 
1580
- Returns **void** automatically synchronized promise through #recorder
1580
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1581
1581
 
1582
1582
  ### pressKeyUp
1583
1583
 
@@ -1595,7 +1595,7 @@ I.pressKeyUp('Control');
1595
1595
 
1596
1596
  * `key` **[string][18]** name of key to release.
1597
1597
 
1598
- Returns **void** automatically synchronized promise through #recorder
1598
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1599
1599
 
1600
1600
  ### refreshPage
1601
1601
 
@@ -1605,7 +1605,7 @@ Reload the current page.
1605
1605
  I.refreshPage();
1606
1606
  ```
1607
1607
 
1608
- Returns **void** automatically synchronized promise through #recorder
1608
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1609
1609
 
1610
1610
  ### resizeWindow
1611
1611
 
@@ -1619,7 +1619,7 @@ First parameter can be set to `maximize`.
1619
1619
  * `width` **[number][23]** width in pixels or `maximize`.
1620
1620
  * `height` **[number][23]** height in pixels.
1621
1621
 
1622
- Returns **void** automatically synchronized promise through #recorder
1622
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1623
1623
 
1624
1624
  ### rightClick
1625
1625
 
@@ -1639,7 +1639,7 @@ I.rightClick('Click me', '.context');
1639
1639
  * `locator` **([string][18] | [object][19])** clickable element located by CSS|XPath|strict locator.
1640
1640
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS|XPath|strict locator.
1641
1641
 
1642
- Returns **void** automatically synchronized promise through #recorder
1642
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1643
1643
 
1644
1644
  ### runInWeb
1645
1645
 
@@ -1681,7 +1681,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
1681
1681
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
1682
1682
  * `fileName` **[string][18]** file name to save.
1683
1683
 
1684
- Returns **void** automatically synchronized promise through #recorder
1684
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1685
1685
 
1686
1686
  ### saveScreenshot
1687
1687
 
@@ -1699,7 +1699,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
1699
1699
  * `fileName` **[string][18]** file name to save.
1700
1700
  * `fullPage` **[boolean][34]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
1701
1701
 
1702
- Returns **void** automatically synchronized promise through #recorder
1702
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1703
1703
 
1704
1704
  ### scrollIntoView
1705
1705
 
@@ -1716,7 +1716,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
1716
1716
  * `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
1717
1717
  * `scrollIntoViewOptions` **(ScrollIntoViewOptions | [boolean][34])** either alignToTop=true|false or scrollIntoViewOptions. See [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][35].
1718
1718
 
1719
- Returns **void** automatically synchronized promise through #recorder
1719
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1720
1720
 
1721
1721
  ### scrollPageToBottom
1722
1722
 
@@ -1726,7 +1726,7 @@ Scroll page to the bottom.
1726
1726
  I.scrollPageToBottom();
1727
1727
  ```
1728
1728
 
1729
- Returns **void** automatically synchronized promise through #recorder
1729
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1730
1730
 
1731
1731
  ### scrollPageToTop
1732
1732
 
@@ -1736,7 +1736,7 @@ Scroll page to the top.
1736
1736
  I.scrollPageToTop();
1737
1737
  ```
1738
1738
 
1739
- Returns **void** automatically synchronized promise through #recorder
1739
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1740
1740
 
1741
1741
  ### scrollTo
1742
1742
 
@@ -1754,7 +1754,7 @@ I.scrollTo('#submit', 5, 5);
1754
1754
  * `offsetX` **[number][23]** (optional, `0` by default) X-axis offset.
1755
1755
  * `offsetY` **[number][23]** (optional, `0` by default) Y-axis offset.
1756
1756
 
1757
- Returns **void** automatically synchronized promise through #recorder
1757
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1758
1758
 
1759
1759
  ### see
1760
1760
 
@@ -1772,7 +1772,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
1772
1772
  * `text` **[string][18]** expected on page.
1773
1773
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1774
1774
 
1775
- Returns **void** automatically synchronized promise through #recorder
1775
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1776
1776
 
1777
1777
  ### seeAttributesOnElements
1778
1778
 
@@ -1787,7 +1787,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
1787
1787
  * `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
1788
1788
  * `attributes` **[object][19]** attributes and their values to check.
1789
1789
 
1790
- Returns **void** automatically synchronized promise through #recorder
1790
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1791
1791
 
1792
1792
  ### seeCheckboxIsChecked
1793
1793
 
@@ -1804,7 +1804,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
1804
1804
 
1805
1805
  * `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
1806
1806
 
1807
- Returns **void** automatically synchronized promise through #recorder
1807
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1808
1808
 
1809
1809
  ### seeClipboardEquals
1810
1810
 
@@ -1822,7 +1822,7 @@ in Chromium-based browsers, where read access is granted automatically.
1822
1822
 
1823
1823
  * `text` **[string][18]** value to check.
1824
1824
 
1825
- Returns **void** automatically synchronized promise through #recorder
1825
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1826
1826
 
1827
1827
  ### seeCookie
1828
1828
 
@@ -1836,7 +1836,7 @@ I.seeCookie('Auth');
1836
1836
 
1837
1837
  * `name` **[string][18]** cookie name.
1838
1838
 
1839
- Returns **void** automatically synchronized promise through #recorder
1839
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1840
1840
 
1841
1841
  ### seeCssPropertiesOnElements
1842
1842
 
@@ -1851,7 +1851,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
1851
1851
  * `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
1852
1852
  * `cssProperties` **[object][19]** object with CSS properties and their values to check.
1853
1853
 
1854
- Returns **void** automatically synchronized promise through #recorder
1854
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1855
1855
 
1856
1856
  ### seeCurrentPathEquals
1857
1857
 
@@ -1867,7 +1867,7 @@ I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
1867
1867
 
1868
1868
  * `path` **[string][18]** value to check.
1869
1869
 
1870
- Returns **void** automatically synchronized promise through #recorder
1870
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1871
1871
 
1872
1872
  ### seeCurrentUrlEquals
1873
1873
 
@@ -1884,7 +1884,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
1884
1884
 
1885
1885
  * `url` **[string][18]** value to check.
1886
1886
 
1887
- Returns **void** automatically synchronized promise through #recorder
1887
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1888
1888
 
1889
1889
  ### seeElement
1890
1890
 
@@ -1907,7 +1907,7 @@ I.seeElement({role: 'dialog'});
1907
1907
  * `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
1908
1908
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1909
1909
 
1910
- Returns **void** automatically synchronized promise through #recorder
1910
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1911
1911
 
1912
1912
  ### seeElementInDOM
1913
1913
 
@@ -1922,7 +1922,7 @@ I.seeElementInDOM('#modal');
1922
1922
 
1923
1923
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
1924
1924
 
1925
- Returns **void** automatically synchronized promise through #recorder
1925
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1926
1926
 
1927
1927
  ### seeInClipboard
1928
1928
 
@@ -1940,7 +1940,7 @@ in Chromium-based browsers, where read access is granted automatically.
1940
1940
 
1941
1941
  * `text` **[string][18]** value to check.
1942
1942
 
1943
- Returns **void** automatically synchronized promise through #recorder
1943
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1944
1944
 
1945
1945
  ### seeInCurrentUrl
1946
1946
 
@@ -1954,7 +1954,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
1954
1954
 
1955
1955
  * `url` **[string][18]** a fragment to check
1956
1956
 
1957
- Returns **void** automatically synchronized promise through #recorder
1957
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1958
1958
 
1959
1959
  ### seeInField
1960
1960
 
@@ -1978,7 +1978,7 @@ I.seeInField('Name', 'John', '.form-container');
1978
1978
  * `value` **([string][18] | [object][19])** value to check.
1979
1979
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1980
1980
 
1981
- Returns **void** automatically synchronized promise through #recorder
1981
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1982
1982
 
1983
1983
  ### seeInPopup
1984
1984
 
@@ -2001,7 +2001,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
2001
2001
 
2002
2002
  * `text` **[string][18]** value to check.
2003
2003
 
2004
- Returns **void** automatically synchronized promise through #recorder
2004
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2005
2005
 
2006
2006
  ### seeInTitle
2007
2007
 
@@ -2015,7 +2015,7 @@ I.seeInTitle('Home Page');
2015
2015
 
2016
2016
  * `text` **[string][18]** text value to check.
2017
2017
 
2018
- Returns **void** automatically synchronized promise through #recorder
2018
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2019
2019
 
2020
2020
  ### seeNumberOfElements
2021
2021
 
@@ -2031,7 +2031,7 @@ I.seeNumberOfElements('#submitBtn', 1);
2031
2031
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2032
2032
  * `num` **[number][23]** number of elements.
2033
2033
 
2034
- Returns **void** automatically synchronized promise through #recorder
2034
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2035
2035
 
2036
2036
  ### seeNumberOfVisibleElements
2037
2037
 
@@ -2047,7 +2047,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
2047
2047
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2048
2048
  * `num` **[number][23]** number of elements.
2049
2049
 
2050
- Returns **void** automatically synchronized promise through #recorder
2050
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2051
2051
 
2052
2052
  ### seeTextEquals
2053
2053
 
@@ -2062,7 +2062,7 @@ I.seeTextEquals('text', 'h1');
2062
2062
  * `text` **[string][18]** element value to check.
2063
2063
  * `context` **([string][18] | [object][19])?** element located by CSS|XPath|strict locator.
2064
2064
 
2065
- Returns **void** automatically synchronized promise through #recorder
2065
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2066
2066
 
2067
2067
  ### seeTitleEquals
2068
2068
 
@@ -2076,7 +2076,7 @@ I.seeTitleEquals('Test title.');
2076
2076
 
2077
2077
  * `text` **[string][18]** value to check.
2078
2078
 
2079
- Returns **void** automatically synchronized promise through #recorder
2079
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2080
2080
 
2081
2081
  ### selectOption
2082
2082
 
@@ -2109,7 +2109,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
2109
2109
  * `option` **([string][18] | [Array][30]<any>)** visible text or value of option.
2110
2110
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
2111
2111
 
2112
- Returns **void** automatically synchronized promise through #recorder
2112
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
2113
2113
 
2114
2114
  ### setCookie
2115
2115
 
@@ -2132,7 +2132,7 @@ I.setCookie([
2132
2132
 
2133
2133
  * `cookie` **(Cookie | [Array][30]<Cookie>)** a cookie object or array of cookie objects.
2134
2134
 
2135
- Returns **void** automatically synchronized promise through #recorder
2135
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2136
2136
 
2137
2137
  ### switchTo
2138
2138
 
@@ -2147,7 +2147,7 @@ I.switchTo(); // switch back to main page
2147
2147
 
2148
2148
  * `locator` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS|XPath|strict locator.
2149
2149
 
2150
- Returns **void** automatically synchronized promise through #recorder
2150
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2151
2151
 
2152
2152
  ### switchToNextTab
2153
2153
 
@@ -2163,7 +2163,7 @@ I.switchToNextTab(2);
2163
2163
  * `num` **[number][23]?** (optional) number of tabs to switch forward, default: 1.
2164
2164
  * `sec` **([number][23] | null)?** (optional) time in seconds to wait.
2165
2165
 
2166
- Returns **void** automatically synchronized promise through #recorder
2166
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2167
2167
 
2168
2168
  ### switchToPreviousTab
2169
2169
 
@@ -2179,7 +2179,7 @@ I.switchToPreviousTab(2);
2179
2179
  * `num` **[number][23]?** (optional) number of tabs to switch backward, default: 1.
2180
2180
  * `sec` **[number][23]??** (optional) time in seconds to wait.
2181
2181
 
2182
- Returns **void** automatically synchronized promise through #recorder
2182
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2183
2183
 
2184
2184
  ### switchToWindow
2185
2185
 
@@ -2225,7 +2225,7 @@ I.type(secret('123456'));
2225
2225
  * `delay` **[number][23]?** (optional) delay in ms between key presses
2226
2226
  * `key` **([string][18] | [Array][30]<[string][18]>)** or array of keys to type.
2227
2227
 
2228
- Returns **void** automatically synchronized promise through #recorder
2228
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2229
2229
 
2230
2230
  ### uncheckOption
2231
2231
 
@@ -2246,7 +2246,7 @@ I.uncheckOption('agree', '//form');
2246
2246
  * `field` **([string][18] | [object][19])** checkbox located by label | name | CSS | XPath | strict locator.
2247
2247
  * `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
2248
2248
 
2249
- Returns **void** automatically synchronized promise through #recorder
2249
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
2250
2250
 
2251
2251
  ### useWebDriverTo
2252
2252
 
@@ -2281,7 +2281,7 @@ I.wait(2); // wait 2 secs
2281
2281
 
2282
2282
  * `sec` **[number][23]** number of second to wait.
2283
2283
 
2284
- Returns **void** automatically synchronized promise through #recorder
2284
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2285
2285
 
2286
2286
  ### waitCurrentPathEquals
2287
2287
 
@@ -2308,7 +2308,7 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
2308
2308
  * `waitTimeout` &#x20;
2309
2309
  * `sec` **[number][23]?** (optional, `1` by default) time in seconds to wait
2310
2310
 
2311
- Returns **void** automatically synchronized promise through #recorder
2311
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2312
2312
 
2313
2313
  ### waitForCookie
2314
2314
 
@@ -2323,7 +2323,7 @@ I.waitForCookie("token");
2323
2323
  * `name` **[string][18]** expected cookie name.
2324
2324
  * `sec` **[number][23]** (optional, `3` by default) time in seconds to wait
2325
2325
 
2326
- Returns **void** automatically synchronized promise through #recorder
2326
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2327
2327
 
2328
2328
  ### waitForDetached
2329
2329
 
@@ -2339,7 +2339,7 @@ I.waitForDetached('#popup');
2339
2339
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2340
2340
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2341
2341
 
2342
- Returns **void** automatically synchronized promise through #recorder
2342
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2343
2343
 
2344
2344
  ### waitForElement
2345
2345
 
@@ -2356,7 +2356,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
2356
2356
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2357
2357
  * `sec` **[number][23]?** (optional, `1` by default) time in seconds to wait
2358
2358
 
2359
- Returns **void** automatically synchronized promise through #recorder
2359
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2360
2360
 
2361
2361
  ### waitForEnabled
2362
2362
 
@@ -2368,7 +2368,7 @@ Element can be located by CSS or XPath.
2368
2368
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2369
2369
  * `sec` **[number][23]** (optional) time in seconds to wait, 1 by default.
2370
2370
 
2371
- Returns **void** automatically synchronized promise through #recorder
2371
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2372
2372
 
2373
2373
  ### waitForFunction
2374
2374
 
@@ -2391,7 +2391,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
2391
2391
  * `argsOrSec` **([Array][30]<any> | [number][23])?** (optional, `1` by default) arguments for function or seconds.
2392
2392
  * `sec` **[number][23]?** (optional, `1` by default) time in seconds to wait
2393
2393
 
2394
- Returns **void** automatically synchronized promise through #recorder
2394
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2395
2395
 
2396
2396
  ### waitForInvisible
2397
2397
 
@@ -2407,7 +2407,7 @@ I.waitForInvisible('#popup');
2407
2407
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2408
2408
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2409
2409
 
2410
- Returns **void** automatically synchronized promise through #recorder
2410
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2411
2411
 
2412
2412
  ### waitForNumberOfTabs
2413
2413
 
@@ -2422,7 +2422,7 @@ I.waitForNumberOfTabs(2);
2422
2422
  * `expectedTabs` **[number][23]** expecting the number of tabs.
2423
2423
  * `sec` **[number][23]** number of secs to wait.
2424
2424
 
2425
- Returns **void** automatically synchronized promise through #recorder
2425
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2426
2426
 
2427
2427
  ### waitForText
2428
2428
 
@@ -2441,7 +2441,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
2441
2441
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2442
2442
  * `context` **([string][18] | [object][19])?** (optional) element located by CSS|XPath|strict locator.
2443
2443
 
2444
- Returns **void** automatically synchronized promise through #recorder
2444
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2445
2445
 
2446
2446
  ### waitForValue
2447
2447
 
@@ -2457,7 +2457,7 @@ I.waitForValue('//input', "GoodValue");
2457
2457
  * `value` **[string][18]** expected value.
2458
2458
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2459
2459
 
2460
- Returns **void** automatically synchronized promise through #recorder
2460
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2461
2461
 
2462
2462
  ### waitForVisible
2463
2463
 
@@ -2473,7 +2473,7 @@ I.waitForVisible('#popup');
2473
2473
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2474
2474
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2475
2475
 
2476
- Returns **void** automatically synchronized promise through #recorder
2476
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2477
2477
 
2478
2478
  ### waitInUrl
2479
2479
 
@@ -2488,7 +2488,7 @@ I.waitInUrl('/info', 2);
2488
2488
  * `urlPart` **[string][18]** value to check.
2489
2489
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2490
2490
 
2491
- Returns **void** automatically synchronized promise through #recorder
2491
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2492
2492
 
2493
2493
  ### waitNumberOfVisibleElements
2494
2494
 
@@ -2504,7 +2504,7 @@ I.waitNumberOfVisibleElements('a', 3);
2504
2504
  * `num` **[number][23]** number of elements.
2505
2505
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2506
2506
 
2507
- Returns **void** automatically synchronized promise through #recorder
2507
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2508
2508
 
2509
2509
  ### waitToHide
2510
2510
 
@@ -2520,7 +2520,7 @@ I.waitToHide('#popup');
2520
2520
  * `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
2521
2521
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2522
2522
 
2523
- Returns **void** automatically synchronized promise through #recorder
2523
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2524
2524
 
2525
2525
  ### waitUrlEquals
2526
2526
 
@@ -2536,7 +2536,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
2536
2536
  * `urlPart` **[string][18]** value to check.
2537
2537
  * `sec` **[number][23]** (optional, `1` by default) time in seconds to wait
2538
2538
 
2539
- Returns **void** automatically synchronized promise through #recorder
2539
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2540
2540
 
2541
2541
  ### _isShadowLocator
2542
2542