codeceptjs 3.5.7 → 3.5.9-beta.1

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 (108) hide show
  1. package/README.md +1 -1
  2. package/docs/build/Appium.js +27 -22
  3. package/docs/build/Nightmare.js +51 -52
  4. package/docs/build/Playwright.js +75 -75
  5. package/docs/build/Protractor.js +64 -65
  6. package/docs/build/Puppeteer.js +74 -75
  7. package/docs/build/TestCafe.js +54 -55
  8. package/docs/build/WebDriver.js +79 -80
  9. package/docs/changelog.md +1 -562
  10. package/docs/community-helpers.md +4 -8
  11. package/docs/examples.md +2 -8
  12. package/docs/helpers/Appium.md +85 -83
  13. package/docs/helpers/Nightmare.md +75 -77
  14. package/docs/helpers/Playwright.md +175 -177
  15. package/docs/helpers/Protractor.md +153 -155
  16. package/docs/helpers/Puppeteer.md +146 -148
  17. package/docs/helpers/TestCafe.md +124 -126
  18. package/docs/helpers/WebDriver.md +155 -157
  19. package/docs/webapi/amOnPage.mustache +1 -1
  20. package/docs/webapi/appendField.mustache +1 -1
  21. package/docs/webapi/attachFile.mustache +1 -1
  22. package/docs/webapi/blur.mustache +1 -1
  23. package/docs/webapi/checkOption.mustache +1 -1
  24. package/docs/webapi/clearCookie.mustache +1 -2
  25. package/docs/webapi/clearField.mustache +1 -1
  26. package/docs/webapi/click.mustache +1 -1
  27. package/docs/webapi/clickLink.mustache +1 -1
  28. package/docs/webapi/closeCurrentTab.mustache +1 -1
  29. package/docs/webapi/closeOtherTabs.mustache +1 -1
  30. package/docs/webapi/dontSee.mustache +1 -1
  31. package/docs/webapi/dontSeeCheckboxIsChecked.mustache +1 -1
  32. package/docs/webapi/dontSeeCookie.mustache +1 -1
  33. package/docs/webapi/dontSeeCurrentUrlEquals.mustache +1 -1
  34. package/docs/webapi/dontSeeElement.mustache +1 -1
  35. package/docs/webapi/dontSeeElementInDOM.mustache +1 -1
  36. package/docs/webapi/dontSeeInCurrentUrl.mustache +1 -1
  37. package/docs/webapi/dontSeeInField.mustache +1 -1
  38. package/docs/webapi/dontSeeInSource.mustache +1 -1
  39. package/docs/webapi/dontSeeInTitle.mustache +1 -1
  40. package/docs/webapi/doubleClick.mustache +1 -1
  41. package/docs/webapi/downloadFile.mustache +1 -1
  42. package/docs/webapi/dragAndDrop.mustache +1 -1
  43. package/docs/webapi/dragSlider.mustache +1 -1
  44. package/docs/webapi/fillField.mustache +1 -1
  45. package/docs/webapi/focus.mustache +1 -1
  46. package/docs/webapi/forceClick.mustache +1 -1
  47. package/docs/webapi/forceRightClick.mustache +1 -1
  48. package/docs/webapi/grabDataFromPerformanceTiming.mustache +1 -1
  49. package/docs/webapi/moveCursorTo.mustache +1 -1
  50. package/docs/webapi/openNewTab.mustache +1 -1
  51. package/docs/webapi/pressKey.mustache +1 -1
  52. package/docs/webapi/pressKeyDown.mustache +1 -1
  53. package/docs/webapi/pressKeyUp.mustache +1 -1
  54. package/docs/webapi/pressKeyWithKeyNormalization.mustache +1 -1
  55. package/docs/webapi/refreshPage.mustache +1 -1
  56. package/docs/webapi/resizeWindow.mustache +1 -1
  57. package/docs/webapi/rightClick.mustache +1 -1
  58. package/docs/webapi/saveElementScreenshot.mustache +1 -1
  59. package/docs/webapi/saveScreenshot.mustache +1 -1
  60. package/docs/webapi/say.mustache +1 -1
  61. package/docs/webapi/scrollIntoView.mustache +1 -1
  62. package/docs/webapi/scrollPageToBottom.mustache +1 -1
  63. package/docs/webapi/scrollPageToTop.mustache +1 -1
  64. package/docs/webapi/scrollTo.mustache +1 -1
  65. package/docs/webapi/see.mustache +1 -1
  66. package/docs/webapi/seeAttributesOnElements.mustache +1 -1
  67. package/docs/webapi/seeCheckboxIsChecked.mustache +1 -1
  68. package/docs/webapi/seeCookie.mustache +1 -1
  69. package/docs/webapi/seeCssPropertiesOnElements.mustache +1 -1
  70. package/docs/webapi/seeCurrentUrlEquals.mustache +1 -1
  71. package/docs/webapi/seeElement.mustache +1 -1
  72. package/docs/webapi/seeElementInDOM.mustache +1 -1
  73. package/docs/webapi/seeInCurrentUrl.mustache +1 -1
  74. package/docs/webapi/seeInField.mustache +1 -1
  75. package/docs/webapi/seeInPopup.mustache +1 -1
  76. package/docs/webapi/seeInSource.mustache +1 -1
  77. package/docs/webapi/seeInTitle.mustache +1 -1
  78. package/docs/webapi/seeNumberOfElements.mustache +1 -1
  79. package/docs/webapi/seeNumberOfVisibleElements.mustache +1 -1
  80. package/docs/webapi/seeTextEquals.mustache +1 -1
  81. package/docs/webapi/seeTitleEquals.mustache +1 -1
  82. package/docs/webapi/selectOption.mustache +1 -1
  83. package/docs/webapi/setCookie.mustache +1 -1
  84. package/docs/webapi/setGeoLocation.mustache +1 -1
  85. package/docs/webapi/switchTo.mustache +1 -1
  86. package/docs/webapi/switchToNextTab.mustache +1 -1
  87. package/docs/webapi/switchToPreviousTab.mustache +1 -1
  88. package/docs/webapi/type.mustache +1 -1
  89. package/docs/webapi/uncheckOption.mustache +1 -1
  90. package/docs/webapi/wait.mustache +1 -1
  91. package/docs/webapi/waitForClickable.mustache +1 -1
  92. package/docs/webapi/waitForDetached.mustache +1 -1
  93. package/docs/webapi/waitForElement.mustache +1 -1
  94. package/docs/webapi/waitForEnabled.mustache +1 -1
  95. package/docs/webapi/waitForFunction.mustache +1 -1
  96. package/docs/webapi/waitForInvisible.mustache +1 -1
  97. package/docs/webapi/waitForText.mustache +1 -1
  98. package/docs/webapi/waitForValue.mustache +1 -1
  99. package/docs/webapi/waitForVisible.mustache +1 -1
  100. package/docs/webapi/waitInUrl.mustache +1 -1
  101. package/docs/webapi/waitNumberOfVisibleElements.mustache +1 -1
  102. package/docs/webapi/waitToHide.mustache +1 -1
  103. package/docs/webapi/waitUrlEquals.mustache +1 -1
  104. package/lib/helper/Appium.js +9 -4
  105. package/lib/helper/Playwright.js +3 -2
  106. package/package.json +5 -5
  107. package/typings/promiseBasedTypes.d.ts +423 -1010
  108. package/typings/types.d.ts +423 -427
@@ -508,10 +508,12 @@ declare namespace CodeceptJS {
508
508
  * I.setNetworkConnection(4) // airplane mode off, wifi off, data on
509
509
  * I.setNetworkConnection(6) // airplane mode off, wifi on, data on
510
510
  * ```
511
- * See corresponding [webdriverio reference](http://webdriver.io/api/mobile/setNetworkConnection.html).
512
- * @returns Appium: support only Android
511
+ * See corresponding [webdriverio reference](https://webdriver.io/docs/api/chromium/#setnetworkconnection).
512
+ *
513
+ * Appium: support only Android
514
+ * @param value - The network connection mode bitmask
513
515
  */
514
- setNetworkConnection(): Promise<{}>;
516
+ setNetworkConnection(value: number): Promise<number>;
515
517
  /**
516
518
  * Update the current setting on the device
517
519
  *
@@ -761,9 +763,8 @@ declare namespace CodeceptJS {
761
763
  * ```
762
764
  * @param field - located by label|name|CSS|XPath|strict locator
763
765
  * @param value - text value to append.
764
- * @returns automatically synchronized promise through #recorder
765
766
  */
766
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
767
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
767
768
  /**
768
769
  * Selects a checkbox or radio button.
769
770
  * Element is located by label or name or CSS or XPath.
@@ -777,9 +778,8 @@ declare namespace CodeceptJS {
777
778
  * ```
778
779
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
779
780
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
780
- * @returns automatically synchronized promise through #recorder
781
781
  */
782
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
782
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
783
783
  /**
784
784
  * Perform a click on a link or a button, given by a locator.
785
785
  * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -804,9 +804,8 @@ declare namespace CodeceptJS {
804
804
  * ```
805
805
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
806
806
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
807
- * @returns automatically synchronized promise through #recorder
808
807
  */
809
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<void>;
808
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<any>;
810
809
  /**
811
810
  * Verifies that the specified checkbox is not checked.
812
811
  *
@@ -816,9 +815,8 @@ declare namespace CodeceptJS {
816
815
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
817
816
  * ```
818
817
  * @param field - located by label|name|CSS|XPath|strict locator.
819
- * @returns automatically synchronized promise through #recorder
820
818
  */
821
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
819
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
822
820
  /**
823
821
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
824
822
  *
@@ -826,9 +824,8 @@ declare namespace CodeceptJS {
826
824
  * I.dontSeeElement('.modal'); // modal is not shown
827
825
  * ```
828
826
  * @param locator - located by CSS|XPath|Strict locator.
829
- * @returns automatically synchronized promise through #recorder
830
827
  */
831
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
828
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
832
829
  /**
833
830
  * Checks that value of input field or textarea doesn't equal to given value
834
831
  * Opposite to `seeInField`.
@@ -839,9 +836,8 @@ declare namespace CodeceptJS {
839
836
  * ```
840
837
  * @param field - located by label|name|CSS|XPath|strict locator.
841
838
  * @param value - value to check.
842
- * @returns automatically synchronized promise through #recorder
843
839
  */
844
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
840
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
845
841
  /**
846
842
  * Opposite to `see`. Checks that a text is not present on a page.
847
843
  * Use context parameter to narrow down the search.
@@ -852,9 +848,8 @@ declare namespace CodeceptJS {
852
848
  * ```
853
849
  * @param text - which is not present.
854
850
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
855
- * @returns automatically synchronized promise through #recorder
856
851
  */
857
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
852
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
858
853
  /**
859
854
  * Fills a text field or textarea, after clearing its value, with the given string.
860
855
  * Field is located by name, label, CSS, or XPath.
@@ -871,9 +866,8 @@ declare namespace CodeceptJS {
871
866
  * ```
872
867
  * @param field - located by label|name|CSS|XPath|strict locator.
873
868
  * @param value - text value to fill.
874
- * @returns automatically synchronized promise through #recorder
875
869
  */
876
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
870
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
877
871
  /**
878
872
  * Retrieves all texts from an element located by CSS or XPath and returns it to test.
879
873
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -979,12 +973,8 @@ declare namespace CodeceptJS {
979
973
  * ```
980
974
  * @param locator - located by CSS|XPath|strict locator.
981
975
  * @param scrollIntoViewOptions - see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
982
- * @returns automatically synchronized promise through #recorder
983
- *
984
- *
985
- * Supported only for web testing
986
976
  */
987
- scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): Promise<void>;
977
+ scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): Promise<any>;
988
978
  /**
989
979
  * Verifies that the specified checkbox is checked.
990
980
  *
@@ -994,9 +984,8 @@ declare namespace CodeceptJS {
994
984
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
995
985
  * ```
996
986
  * @param field - located by label|name|CSS|XPath|strict locator.
997
- * @returns automatically synchronized promise through #recorder
998
987
  */
999
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
988
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
1000
989
  /**
1001
990
  * Checks that a given Element is visible
1002
991
  * Element is located by CSS or XPath.
@@ -1005,9 +994,8 @@ declare namespace CodeceptJS {
1005
994
  * I.seeElement('#modal');
1006
995
  * ```
1007
996
  * @param locator - located by CSS|XPath|strict locator.
1008
- * @returns automatically synchronized promise through #recorder
1009
997
  */
1010
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
998
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
1011
999
  /**
1012
1000
  * Checks that the given input field or textarea equals to given value.
1013
1001
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -1020,9 +1008,8 @@ declare namespace CodeceptJS {
1020
1008
  * ```
1021
1009
  * @param field - located by label|name|CSS|XPath|strict locator.
1022
1010
  * @param value - value to check.
1023
- * @returns automatically synchronized promise through #recorder
1024
1011
  */
1025
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
1012
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
1026
1013
  /**
1027
1014
  * Checks that a page contains a visible text.
1028
1015
  * Use context parameter to narrow down the search.
@@ -1034,9 +1021,8 @@ declare namespace CodeceptJS {
1034
1021
  * ```
1035
1022
  * @param text - expected on page.
1036
1023
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1037
- * @returns automatically synchronized promise through #recorder
1038
1024
  */
1039
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
1025
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
1040
1026
  /**
1041
1027
  * Selects an option in a drop-down select.
1042
1028
  * Field is searched by label | name | CSS | XPath.
@@ -1058,12 +1044,8 @@ declare namespace CodeceptJS {
1058
1044
  * ```
1059
1045
  * @param select - field located by label|name|CSS|XPath|strict locator.
1060
1046
  * @param option - visible text or value of option.
1061
- * @returns automatically synchronized promise through #recorder
1062
- *
1063
- *
1064
- * Supported only for web testing
1065
1047
  */
1066
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
1048
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
1067
1049
  /**
1068
1050
  * Waits for element to be present on page (by default waits for 1sec).
1069
1051
  * Element can be located by CSS or XPath.
@@ -1074,9 +1056,8 @@ declare namespace CodeceptJS {
1074
1056
  * ```
1075
1057
  * @param locator - element located by CSS|XPath|strict locator.
1076
1058
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
1077
- * @returns automatically synchronized promise through #recorder
1078
1059
  */
1079
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
1060
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
1080
1061
  /**
1081
1062
  * Waits for an element to become visible on a page (by default waits for 1sec).
1082
1063
  * Element can be located by CSS or XPath.
@@ -1086,9 +1067,8 @@ declare namespace CodeceptJS {
1086
1067
  * ```
1087
1068
  * @param locator - element located by CSS|XPath|strict locator.
1088
1069
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
1089
- * @returns automatically synchronized promise through #recorder
1090
1070
  */
1091
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
1071
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
1092
1072
  /**
1093
1073
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
1094
1074
  * Element can be located by CSS or XPath.
@@ -1098,9 +1078,8 @@ declare namespace CodeceptJS {
1098
1078
  * ```
1099
1079
  * @param locator - element located by CSS|XPath|strict locator.
1100
1080
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
1101
- * @returns automatically synchronized promise through #recorder
1102
1081
  */
1103
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
1082
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
1104
1083
  /**
1105
1084
  * Waits for a text to appear (by default waits for 1sec).
1106
1085
  * Element can be located by CSS or XPath.
@@ -1113,9 +1092,8 @@ declare namespace CodeceptJS {
1113
1092
  * @param text - to wait for.
1114
1093
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
1115
1094
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
1116
- * @returns automatically synchronized promise through #recorder
1117
1095
  */
1118
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
1096
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
1119
1097
  }
1120
1098
  /**
1121
1099
  * This helper allows performing assertions based on Chai.
@@ -1837,9 +1815,8 @@ declare namespace CodeceptJS {
1837
1815
  * ```
1838
1816
  * @param url - url path or global url.
1839
1817
  * @param headers - list of request headers can be passed
1840
- * @returns automatically synchronized promise through #recorder
1841
1818
  */
1842
- amOnPage(url: string, headers: any): Promise<void>;
1819
+ amOnPage(url: string, headers: any): Promise<any>;
1843
1820
  /**
1844
1821
  * Checks that title contains text.
1845
1822
  *
@@ -1847,9 +1824,8 @@ declare namespace CodeceptJS {
1847
1824
  * I.seeInTitle('Home Page');
1848
1825
  * ```
1849
1826
  * @param text - text value to check.
1850
- * @returns automatically synchronized promise through #recorder
1851
1827
  */
1852
- seeInTitle(text: string): Promise<void>;
1828
+ seeInTitle(text: string): Promise<any>;
1853
1829
  /**
1854
1830
  * Checks that title does not contain text.
1855
1831
  *
@@ -1857,9 +1833,8 @@ declare namespace CodeceptJS {
1857
1833
  * I.dontSeeInTitle('Error');
1858
1834
  * ```
1859
1835
  * @param text - value to check.
1860
- * @returns automatically synchronized promise through #recorder
1861
1836
  */
1862
- dontSeeInTitle(text: string): Promise<void>;
1837
+ dontSeeInTitle(text: string): Promise<any>;
1863
1838
  /**
1864
1839
  * Retrieves a page title and returns it to test.
1865
1840
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -1888,15 +1863,13 @@ declare namespace CodeceptJS {
1888
1863
  * I.seeInCurrentUrl('/register'); // we are on registration page
1889
1864
  * ```
1890
1865
  * @param url - a fragment to check
1891
- * @returns automatically synchronized promise through #recorder
1892
1866
  */
1893
- seeInCurrentUrl(url: string): Promise<void>;
1867
+ seeInCurrentUrl(url: string): Promise<any>;
1894
1868
  /**
1895
1869
  * Checks that current url does not contain a provided fragment.
1896
1870
  * @param url - value to check.
1897
- * @returns automatically synchronized promise through #recorder
1898
1871
  */
1899
- dontSeeInCurrentUrl(url: string): Promise<void>;
1872
+ dontSeeInCurrentUrl(url: string): Promise<any>;
1900
1873
  /**
1901
1874
  * Checks that current url is equal to provided one.
1902
1875
  * If a relative url provided, a configured url will be prepended to it.
@@ -1907,9 +1880,8 @@ declare namespace CodeceptJS {
1907
1880
  * I.seeCurrentUrlEquals('http://my.site.com/register');
1908
1881
  * ```
1909
1882
  * @param url - value to check.
1910
- * @returns automatically synchronized promise through #recorder
1911
1883
  */
1912
- seeCurrentUrlEquals(url: string): Promise<void>;
1884
+ seeCurrentUrlEquals(url: string): Promise<any>;
1913
1885
  /**
1914
1886
  * Checks that current url is not equal to provided one.
1915
1887
  * If a relative url provided, a configured url will be prepended to it.
@@ -1919,9 +1891,8 @@ declare namespace CodeceptJS {
1919
1891
  * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
1920
1892
  * ```
1921
1893
  * @param url - value to check.
1922
- * @returns automatically synchronized promise through #recorder
1923
1894
  */
1924
- dontSeeCurrentUrlEquals(url: string): Promise<void>;
1895
+ dontSeeCurrentUrlEquals(url: string): Promise<any>;
1925
1896
  /**
1926
1897
  * Checks that a page contains a visible text.
1927
1898
  * Use context parameter to narrow down the search.
@@ -1933,9 +1904,8 @@ declare namespace CodeceptJS {
1933
1904
  * ```
1934
1905
  * @param text - expected on page.
1935
1906
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1936
- * @returns automatically synchronized promise through #recorder
1937
1907
  */
1938
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
1908
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
1939
1909
  /**
1940
1910
  * Opposite to `see`. Checks that a text is not present on a page.
1941
1911
  * Use context parameter to narrow down the search.
@@ -1946,9 +1916,8 @@ declare namespace CodeceptJS {
1946
1916
  * ```
1947
1917
  * @param text - which is not present.
1948
1918
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
1949
- * @returns automatically synchronized promise through #recorder
1950
1919
  */
1951
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
1920
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
1952
1921
  /**
1953
1922
  * Checks that a given Element is visible
1954
1923
  * Element is located by CSS or XPath.
@@ -1957,9 +1926,8 @@ declare namespace CodeceptJS {
1957
1926
  * I.seeElement('#modal');
1958
1927
  * ```
1959
1928
  * @param locator - located by CSS|XPath|strict locator.
1960
- * @returns automatically synchronized promise through #recorder
1961
1929
  */
1962
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
1930
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
1963
1931
  /**
1964
1932
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
1965
1933
  *
@@ -1967,9 +1935,8 @@ declare namespace CodeceptJS {
1967
1935
  * I.dontSeeElement('.modal'); // modal is not shown
1968
1936
  * ```
1969
1937
  * @param locator - located by CSS|XPath|Strict locator.
1970
- * @returns automatically synchronized promise through #recorder
1971
1938
  */
1972
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
1939
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
1973
1940
  /**
1974
1941
  * Checks that a given Element is present in the DOM
1975
1942
  * Element is located by CSS or XPath.
@@ -1978,9 +1945,8 @@ declare namespace CodeceptJS {
1978
1945
  * I.seeElementInDOM('#modal');
1979
1946
  * ```
1980
1947
  * @param locator - element located by CSS|XPath|strict locator.
1981
- * @returns automatically synchronized promise through #recorder
1982
1948
  */
1983
- seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
1949
+ seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
1984
1950
  /**
1985
1951
  * Opposite to `seeElementInDOM`. Checks that element is not on page.
1986
1952
  *
@@ -1988,9 +1954,8 @@ declare namespace CodeceptJS {
1988
1954
  * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
1989
1955
  * ```
1990
1956
  * @param locator - located by CSS|XPath|Strict locator.
1991
- * @returns automatically synchronized promise through #recorder
1992
1957
  */
1993
- dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
1958
+ dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
1994
1959
  /**
1995
1960
  * Checks that the current page contains the given string in its raw source code.
1996
1961
  *
@@ -1998,9 +1963,8 @@ declare namespace CodeceptJS {
1998
1963
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
1999
1964
  * ```
2000
1965
  * @param text - value to check.
2001
- * @returns automatically synchronized promise through #recorder
2002
1966
  */
2003
- seeInSource(text: string): Promise<void>;
1967
+ seeInSource(text: string): Promise<any>;
2004
1968
  /**
2005
1969
  * Checks that the current page does not contains the given string in its raw source code.
2006
1970
  *
@@ -2008,9 +1972,8 @@ declare namespace CodeceptJS {
2008
1972
  * I.dontSeeInSource('<!--'); // no comments in source
2009
1973
  * ```
2010
1974
  * @param value - to check.
2011
- * @returns automatically synchronized promise through #recorder
2012
1975
  */
2013
- dontSeeInSource(value: string): Promise<void>;
1976
+ dontSeeInSource(value: string): Promise<any>;
2014
1977
  /**
2015
1978
  * Asserts that an element appears a given number of times in the DOM.
2016
1979
  * Element is located by label or name or CSS or XPath.
@@ -2021,9 +1984,8 @@ declare namespace CodeceptJS {
2021
1984
  * ```
2022
1985
  * @param locator - element located by CSS|XPath|strict locator.
2023
1986
  * @param num - number of elements.
2024
- * @returns automatically synchronized promise through #recorder
2025
1987
  */
2026
- seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
1988
+ seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
2027
1989
  /**
2028
1990
  * Asserts that an element is visible a given number of times.
2029
1991
  * Element is located by CSS or XPath.
@@ -2033,9 +1995,8 @@ declare namespace CodeceptJS {
2033
1995
  * ```
2034
1996
  * @param locator - element located by CSS|XPath|strict locator.
2035
1997
  * @param num - number of elements.
2036
- * @returns automatically synchronized promise through #recorder
2037
1998
  */
2038
- seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
1999
+ seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
2039
2000
  /**
2040
2001
  * Grab number of visible elements by locator.
2041
2002
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -2071,9 +2032,8 @@ declare namespace CodeceptJS {
2071
2032
  * ```
2072
2033
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
2073
2034
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
2074
- * @returns automatically synchronized promise through #recorder
2075
2035
  */
2076
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<void>;
2036
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<any>;
2077
2037
  /**
2078
2038
  * Performs a double-click on an element matched by link|button|label|CSS or XPath.
2079
2039
  * Context can be specified as second parameter to narrow search.
@@ -2086,9 +2046,8 @@ declare namespace CodeceptJS {
2086
2046
  * ```
2087
2047
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
2088
2048
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
2089
- * @returns automatically synchronized promise through #recorder
2090
2049
  */
2091
- doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
2050
+ doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
2092
2051
  /**
2093
2052
  * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
2094
2053
  *
@@ -2102,9 +2061,8 @@ declare namespace CodeceptJS {
2102
2061
  * ```
2103
2062
  * @param locator - clickable element located by CSS|XPath|strict locator.
2104
2063
  * @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
2105
- * @returns automatically synchronized promise through #recorder
2106
2064
  */
2107
- rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
2065
+ rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
2108
2066
  /**
2109
2067
  * Moves cursor to element matched by locator.
2110
2068
  * Extra shift can be set with offsetX and offsetY options.
@@ -2116,9 +2074,8 @@ declare namespace CodeceptJS {
2116
2074
  * @param locator - located by CSS|XPath|strict locator.
2117
2075
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
2118
2076
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
2119
- * @returns automatically synchronized promise through #recorder
2120
2077
  */
2121
- moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
2078
+ moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
2122
2079
  /**
2123
2080
  * Executes sync script on a page.
2124
2081
  * Pass arguments to function as additional parameters.
@@ -2185,9 +2142,8 @@ declare namespace CodeceptJS {
2185
2142
  * First parameter can be set to `maximize`.
2186
2143
  * @param width - width in pixels or `maximize`.
2187
2144
  * @param height - height in pixels.
2188
- * @returns automatically synchronized promise through #recorder
2189
2145
  */
2190
- resizeWindow(width: number, height: number): Promise<void>;
2146
+ resizeWindow(width: number, height: number): Promise<any>;
2191
2147
  /**
2192
2148
  * Selects a checkbox or radio button.
2193
2149
  * Element is located by label or name or CSS or XPath.
@@ -2201,9 +2157,8 @@ declare namespace CodeceptJS {
2201
2157
  * ```
2202
2158
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
2203
2159
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
2204
- * @returns automatically synchronized promise through #recorder
2205
2160
  */
2206
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
2161
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
2207
2162
  /**
2208
2163
  * Unselects a checkbox or radio button.
2209
2164
  * Element is located by label or name or CSS or XPath.
@@ -2217,9 +2172,8 @@ declare namespace CodeceptJS {
2217
2172
  * ```
2218
2173
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
2219
2174
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
2220
- * @returns automatically synchronized promise through #recorder
2221
2175
  */
2222
- uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
2176
+ uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
2223
2177
  /**
2224
2178
  * Fills a text field or textarea, after clearing its value, with the given string.
2225
2179
  * Field is located by name, label, CSS, or XPath.
@@ -2236,9 +2190,8 @@ declare namespace CodeceptJS {
2236
2190
  * ```
2237
2191
  * @param field - located by label|name|CSS|XPath|strict locator.
2238
2192
  * @param value - text value to fill.
2239
- * @returns automatically synchronized promise through #recorder
2240
2193
  */
2241
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
2194
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
2242
2195
  /**
2243
2196
  * Clears a `<textarea>` or text `<input>` element's value.
2244
2197
  *
@@ -2248,9 +2201,8 @@ declare namespace CodeceptJS {
2248
2201
  * I.clearField('#email');
2249
2202
  * ```
2250
2203
  * @param editable - field located by label|name|CSS|XPath|strict locator.
2251
- * @returns automatically synchronized promise through #recorder.
2252
2204
  */
2253
- clearField(editable: LocatorOrString): Promise<void>;
2205
+ clearField(editable: LocatorOrString): Promise<any>;
2254
2206
  /**
2255
2207
  * Appends text to a input field or textarea.
2256
2208
  * Field is located by name, label, CSS or XPath
@@ -2262,9 +2214,8 @@ declare namespace CodeceptJS {
2262
2214
  * ```
2263
2215
  * @param field - located by label|name|CSS|XPath|strict locator
2264
2216
  * @param value - text value to append.
2265
- * @returns automatically synchronized promise through #recorder
2266
2217
  */
2267
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
2218
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
2268
2219
  /**
2269
2220
  * Checks that the given input field or textarea equals to given value.
2270
2221
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -2277,9 +2228,8 @@ declare namespace CodeceptJS {
2277
2228
  * ```
2278
2229
  * @param field - located by label|name|CSS|XPath|strict locator.
2279
2230
  * @param value - value to check.
2280
- * @returns automatically synchronized promise through #recorder
2281
2231
  */
2282
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
2232
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
2283
2233
  /**
2284
2234
  * Checks that value of input field or textarea doesn't equal to given value
2285
2235
  * Opposite to `seeInField`.
@@ -2290,9 +2240,8 @@ declare namespace CodeceptJS {
2290
2240
  * ```
2291
2241
  * @param field - located by label|name|CSS|XPath|strict locator.
2292
2242
  * @param value - value to check.
2293
- * @returns automatically synchronized promise through #recorder
2294
2243
  */
2295
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
2244
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
2296
2245
  /**
2297
2246
  * Sends [input event](http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent) on a page.
2298
2247
  * Can submit special keys like 'Enter', 'Backspace', etc
@@ -2318,9 +2267,8 @@ declare namespace CodeceptJS {
2318
2267
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
2319
2268
  * ```
2320
2269
  * @param field - located by label|name|CSS|XPath|strict locator.
2321
- * @returns automatically synchronized promise through #recorder
2322
2270
  */
2323
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
2271
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
2324
2272
  /**
2325
2273
  * Verifies that the specified checkbox is not checked.
2326
2274
  *
@@ -2330,9 +2278,8 @@ declare namespace CodeceptJS {
2330
2278
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
2331
2279
  * ```
2332
2280
  * @param field - located by label|name|CSS|XPath|strict locator.
2333
- * @returns automatically synchronized promise through #recorder
2334
2281
  */
2335
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
2282
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
2336
2283
  /**
2337
2284
  * Attaches a file to element located by label, name, CSS or XPath
2338
2285
  * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -2344,12 +2291,8 @@ declare namespace CodeceptJS {
2344
2291
  * ```
2345
2292
  * @param locator - field located by label|name|CSS|XPath|strict locator.
2346
2293
  * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
2347
- * @returns automatically synchronized promise through #recorder
2348
- *
2349
- *
2350
- * Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more](https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs))
2351
2294
  */
2352
- attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<void>;
2295
+ attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
2353
2296
  /**
2354
2297
  * Retrieves all texts from an element located by CSS or XPath and returns it to test.
2355
2298
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -2478,9 +2421,8 @@ declare namespace CodeceptJS {
2478
2421
  * ```
2479
2422
  * @param select - field located by label|name|CSS|XPath|strict locator.
2480
2423
  * @param option - visible text or value of option.
2481
- * @returns automatically synchronized promise through #recorder
2482
2424
  */
2483
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
2425
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
2484
2426
  /**
2485
2427
  * Sets cookie(s).
2486
2428
  *
@@ -2496,13 +2438,8 @@ declare namespace CodeceptJS {
2496
2438
  * ]);
2497
2439
  * ```
2498
2440
  * @param cookie - a cookie object or array of cookie objects.
2499
- * @returns automatically synchronized promise through #recorder
2500
- *
2501
- *
2502
- * Wrapper for `.cookies.set(cookie)`.
2503
- * [See more](https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie)
2504
2441
  */
2505
- setCookie(cookie: Cookie | Cookie[]): Promise<void>;
2442
+ setCookie(cookie: Cookie | Cookie[]): Promise<any>;
2506
2443
  /**
2507
2444
  * Checks that cookie with given name exists.
2508
2445
  *
@@ -2510,9 +2447,8 @@ declare namespace CodeceptJS {
2510
2447
  * I.seeCookie('Auth');
2511
2448
  * ```
2512
2449
  * @param name - cookie name.
2513
- * @returns automatically synchronized promise through #recorder
2514
2450
  */
2515
- seeCookie(name: string): Promise<void>;
2451
+ seeCookie(name: string): Promise<any>;
2516
2452
  /**
2517
2453
  * Checks that cookie with given name does not exist.
2518
2454
  *
@@ -2520,9 +2456,8 @@ declare namespace CodeceptJS {
2520
2456
  * I.dontSeeCookie('auth'); // no auth cookie
2521
2457
  * ```
2522
2458
  * @param name - cookie name.
2523
- * @returns automatically synchronized promise through #recorder
2524
2459
  */
2525
- dontSeeCookie(name: string): Promise<void>;
2460
+ dontSeeCookie(name: string): Promise<any>;
2526
2461
  /**
2527
2462
  * Gets a cookie object by name.
2528
2463
  * If none provided gets all cookies.
@@ -2541,12 +2476,11 @@ declare namespace CodeceptJS {
2541
2476
  *
2542
2477
  * ```js
2543
2478
  * I.clearCookie();
2544
- * I.clearCookie('test');
2479
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
2545
2480
  * ```
2546
2481
  * @param [cookie = null] - (optional, `null` by default) cookie name
2547
- * @returns automatically synchronized promise through #recorder
2548
2482
  */
2549
- clearCookie(cookie?: string): Promise<void>;
2483
+ clearCookie(cookie?: string): Promise<any>;
2550
2484
  /**
2551
2485
  * Waits for a function to return true (waits for 1 sec by default).
2552
2486
  * Running in browser context.
@@ -2563,9 +2497,8 @@ declare namespace CodeceptJS {
2563
2497
  * @param fn - to be executed in browser context.
2564
2498
  * @param [argsOrSec = null] - (optional, `1` by default) arguments for function or seconds.
2565
2499
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
2566
- * @returns automatically synchronized promise through #recorder
2567
2500
  */
2568
- waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<void>;
2501
+ waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
2569
2502
  /**
2570
2503
  * Pauses execution for a number of seconds.
2571
2504
  *
@@ -2573,9 +2506,8 @@ declare namespace CodeceptJS {
2573
2506
  * I.wait(2); // wait 2 secs
2574
2507
  * ```
2575
2508
  * @param sec - number of second to wait.
2576
- * @returns automatically synchronized promise through #recorder
2577
2509
  */
2578
- wait(sec: number): Promise<void>;
2510
+ wait(sec: number): Promise<any>;
2579
2511
  /**
2580
2512
  * Waits for a text to appear (by default waits for 1sec).
2581
2513
  * Element can be located by CSS or XPath.
@@ -2588,9 +2520,8 @@ declare namespace CodeceptJS {
2588
2520
  * @param text - to wait for.
2589
2521
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
2590
2522
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
2591
- * @returns automatically synchronized promise through #recorder
2592
2523
  */
2593
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
2524
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
2594
2525
  /**
2595
2526
  * Waits for an element to become visible on a page (by default waits for 1sec).
2596
2527
  * Element can be located by CSS or XPath.
@@ -2600,9 +2531,8 @@ declare namespace CodeceptJS {
2600
2531
  * ```
2601
2532
  * @param locator - element located by CSS|XPath|strict locator.
2602
2533
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
2603
- * @returns automatically synchronized promise through #recorder
2604
2534
  */
2605
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
2535
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
2606
2536
  /**
2607
2537
  * Waits for an element to hide (by default waits for 1sec).
2608
2538
  * Element can be located by CSS or XPath.
@@ -2612,9 +2542,8 @@ declare namespace CodeceptJS {
2612
2542
  * ```
2613
2543
  * @param locator - element located by CSS|XPath|strict locator.
2614
2544
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
2615
- * @returns automatically synchronized promise through #recorder
2616
2545
  */
2617
- waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
2546
+ waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
2618
2547
  /**
2619
2548
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
2620
2549
  * Element can be located by CSS or XPath.
@@ -2624,9 +2553,8 @@ declare namespace CodeceptJS {
2624
2553
  * ```
2625
2554
  * @param locator - element located by CSS|XPath|strict locator.
2626
2555
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
2627
- * @returns automatically synchronized promise through #recorder
2628
2556
  */
2629
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
2557
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
2630
2558
  /**
2631
2559
  * Waits for element to be present on page (by default waits for 1sec).
2632
2560
  * Element can be located by CSS or XPath.
@@ -2637,9 +2565,8 @@ declare namespace CodeceptJS {
2637
2565
  * ```
2638
2566
  * @param locator - element located by CSS|XPath|strict locator.
2639
2567
  * @param [sec] - (optional, `1` by default) time in seconds to wait
2640
- * @returns automatically synchronized promise through #recorder
2641
2568
  */
2642
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
2569
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
2643
2570
  /**
2644
2571
  * Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
2645
2572
  * Element can be located by CSS or XPath.
@@ -2649,18 +2576,16 @@ declare namespace CodeceptJS {
2649
2576
  * ```
2650
2577
  * @param locator - element located by CSS|XPath|strict locator.
2651
2578
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
2652
- * @returns automatically synchronized promise through #recorder
2653
2579
  */
2654
- waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
2580
+ waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
2655
2581
  /**
2656
2582
  * Reload the current page.
2657
2583
  *
2658
2584
  * ```js
2659
2585
  * I.refreshPage();
2660
2586
  * ```
2661
- * @returns automatically synchronized promise through #recorder
2662
2587
  */
2663
- refreshPage(): Promise<void>;
2588
+ refreshPage(): Promise<any>;
2664
2589
  /**
2665
2590
  * Reload the page
2666
2591
  */
@@ -2674,9 +2599,8 @@ declare namespace CodeceptJS {
2674
2599
  * ```
2675
2600
  * @param locator - element located by CSS|XPath|strict locator.
2676
2601
  * @param fileName - file name to save.
2677
- * @returns automatically synchronized promise through #recorder
2678
2602
  */
2679
- saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<void>;
2603
+ saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<any>;
2680
2604
  /**
2681
2605
  * Grab the width, height, location of given locator.
2682
2606
  * Provide `width` or `height`as second param to get your desired prop.
@@ -2711,9 +2635,8 @@ declare namespace CodeceptJS {
2711
2635
  * ```
2712
2636
  * @param fileName - file name to save.
2713
2637
  * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
2714
- * @returns automatically synchronized promise through #recorder
2715
2638
  */
2716
- saveScreenshot(fileName: string, fullPage?: boolean): Promise<void>;
2639
+ saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
2717
2640
  /**
2718
2641
  * Scrolls to element matched by locator.
2719
2642
  * Extra shift can be set with offsetX and offsetY options.
@@ -2725,27 +2648,24 @@ declare namespace CodeceptJS {
2725
2648
  * @param locator - located by CSS|XPath|strict locator.
2726
2649
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
2727
2650
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
2728
- * @returns automatically synchronized promise through #recorder
2729
2651
  */
2730
- scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
2652
+ scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
2731
2653
  /**
2732
2654
  * Scroll page to the top.
2733
2655
  *
2734
2656
  * ```js
2735
2657
  * I.scrollPageToTop();
2736
2658
  * ```
2737
- * @returns automatically synchronized promise through #recorder
2738
2659
  */
2739
- scrollPageToTop(): Promise<void>;
2660
+ scrollPageToTop(): Promise<any>;
2740
2661
  /**
2741
2662
  * Scroll page to the bottom.
2742
2663
  *
2743
2664
  * ```js
2744
2665
  * I.scrollPageToBottom();
2745
2666
  * ```
2746
- * @returns automatically synchronized promise through #recorder
2747
2667
  */
2748
- scrollPageToBottom(): Promise<void>;
2668
+ scrollPageToBottom(): Promise<any>;
2749
2669
  /**
2750
2670
  * Retrieves a page scroll position and returns it to test.
2751
2671
  * Resumes test execution, so **should be used inside an async function with `await`** operator.
@@ -3058,9 +2978,8 @@ declare namespace CodeceptJS {
3058
2978
  * I.seeInPopup('Popup text');
3059
2979
  * ```
3060
2980
  * @param text - value to check.
3061
- * @returns automatically synchronized promise through #recorder
3062
2981
  */
3063
- seeInPopup(text: string): Promise<void>;
2982
+ seeInPopup(text: string): Promise<any>;
3064
2983
  /**
3065
2984
  * Set current page
3066
2985
  * @param page - page to set
@@ -3098,30 +3017,15 @@ declare namespace CodeceptJS {
3098
3017
  * I.amOnPage('/login'); // opens a login page
3099
3018
  * ```
3100
3019
  * @param url - url path or global url.
3101
- * @returns automatically synchronized promise through #recorder
3102
3020
  */
3103
- amOnPage(url: string): Promise<void>;
3021
+ amOnPage(url: string): Promise<any>;
3104
3022
  /**
3105
3023
  * Resize the current window to provided width and height.
3106
3024
  * First parameter can be set to `maximize`.
3107
3025
  * @param width - width in pixels or `maximize`.
3108
3026
  * @param height - height in pixels.
3109
- * @returns automatically synchronized promise through #recorder
3110
- *
3111
- *
3112
- * Unlike other drivers Playwright changes the size of a viewport, not the window!
3113
- * Playwright does not control the window of a browser so it can't adjust its real size.
3114
- * It also can't maximize a window.
3115
- *
3116
- * Update configuration to change real window size on start:
3117
- *
3118
- * ```js
3119
- * // inside codecept.conf.js
3120
- * // @codeceptjs/configure package must be installed
3121
- * { setWindowSize } = require('@codeceptjs/configure');
3122
- * ````
3123
3027
  */
3124
- resizeWindow(width: number, height: number): Promise<void>;
3028
+ resizeWindow(width: number, height: number): Promise<any>;
3125
3029
  /**
3126
3030
  * Set headers for all next requests
3127
3031
  *
@@ -3144,9 +3048,8 @@ declare namespace CodeceptJS {
3144
3048
  * @param locator - located by CSS|XPath|strict locator.
3145
3049
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
3146
3050
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
3147
- * @returns automatically synchronized promise through #recorder
3148
3051
  */
3149
- moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
3052
+ moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
3150
3053
  /**
3151
3054
  * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
3152
3055
  *
@@ -3159,9 +3062,8 @@ declare namespace CodeceptJS {
3159
3062
  * ```
3160
3063
  * @param locator - field located by label|name|CSS|XPath|strict locator.
3161
3064
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
3162
- * @returns automatically synchronized promise through #recorder
3163
3065
  */
3164
- focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
3066
+ focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
3165
3067
  /**
3166
3068
  * Remove focus from a text input, button, etc.
3167
3069
  * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
@@ -3179,9 +3081,8 @@ declare namespace CodeceptJS {
3179
3081
  * ```
3180
3082
  * @param locator - field located by label|name|CSS|XPath|strict locator.
3181
3083
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
3182
- * @returns automatically synchronized promise through #recorder
3183
3084
  */
3184
- blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
3085
+ blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
3185
3086
  /**
3186
3087
  * Return the checked status of given element.
3187
3088
  * @param locator - element located by CSS|XPath|strict locator.
@@ -3210,9 +3111,8 @@ declare namespace CodeceptJS {
3210
3111
  * ```
3211
3112
  *
3212
3113
  * > When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`
3213
- * @returns automatically synchronized promise through #recorder
3214
3114
  */
3215
- dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): Promise<void>;
3115
+ dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): Promise<any>;
3216
3116
  /**
3217
3117
  * Restart browser with a new context and a new page
3218
3118
  *
@@ -3233,27 +3133,24 @@ declare namespace CodeceptJS {
3233
3133
  * ```js
3234
3134
  * I.refreshPage();
3235
3135
  * ```
3236
- * @returns automatically synchronized promise through #recorder
3237
3136
  */
3238
- refreshPage(): Promise<void>;
3137
+ refreshPage(): Promise<any>;
3239
3138
  /**
3240
3139
  * Scroll page to the top.
3241
3140
  *
3242
3141
  * ```js
3243
3142
  * I.scrollPageToTop();
3244
3143
  * ```
3245
- * @returns automatically synchronized promise through #recorder
3246
3144
  */
3247
- scrollPageToTop(): Promise<void>;
3145
+ scrollPageToTop(): Promise<any>;
3248
3146
  /**
3249
3147
  * Scroll page to the bottom.
3250
3148
  *
3251
3149
  * ```js
3252
3150
  * I.scrollPageToBottom();
3253
3151
  * ```
3254
- * @returns automatically synchronized promise through #recorder
3255
3152
  */
3256
- scrollPageToBottom(): Promise<void>;
3153
+ scrollPageToBottom(): Promise<any>;
3257
3154
  /**
3258
3155
  * Scrolls to element matched by locator.
3259
3156
  * Extra shift can be set with offsetX and offsetY options.
@@ -3265,9 +3162,8 @@ declare namespace CodeceptJS {
3265
3162
  * @param locator - located by CSS|XPath|strict locator.
3266
3163
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
3267
3164
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
3268
- * @returns automatically synchronized promise through #recorder
3269
3165
  */
3270
- scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
3166
+ scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
3271
3167
  /**
3272
3168
  * Checks that title contains text.
3273
3169
  *
@@ -3275,9 +3171,8 @@ declare namespace CodeceptJS {
3275
3171
  * I.seeInTitle('Home Page');
3276
3172
  * ```
3277
3173
  * @param text - text value to check.
3278
- * @returns automatically synchronized promise through #recorder
3279
3174
  */
3280
- seeInTitle(text: string): Promise<void>;
3175
+ seeInTitle(text: string): Promise<any>;
3281
3176
  /**
3282
3177
  * Retrieves a page scroll position and returns it to test.
3283
3178
  * Resumes test execution, so **should be used inside an async function with `await`** operator.
@@ -3295,9 +3190,8 @@ declare namespace CodeceptJS {
3295
3190
  * I.seeTitleEquals('Test title.');
3296
3191
  * ```
3297
3192
  * @param text - value to check.
3298
- * @returns automatically synchronized promise through #recorder
3299
3193
  */
3300
- seeTitleEquals(text: string): Promise<void>;
3194
+ seeTitleEquals(text: string): Promise<any>;
3301
3195
  /**
3302
3196
  * Checks that title does not contain text.
3303
3197
  *
@@ -3305,9 +3199,8 @@ declare namespace CodeceptJS {
3305
3199
  * I.dontSeeInTitle('Error');
3306
3200
  * ```
3307
3201
  * @param text - value to check.
3308
- * @returns automatically synchronized promise through #recorder
3309
3202
  */
3310
- dontSeeInTitle(text: string): Promise<void>;
3203
+ dontSeeInTitle(text: string): Promise<any>;
3311
3204
  /**
3312
3205
  * Retrieves a page title and returns it to test.
3313
3206
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -3428,9 +3321,8 @@ declare namespace CodeceptJS {
3428
3321
  * I.seeElement('#modal');
3429
3322
  * ```
3430
3323
  * @param locator - located by CSS|XPath|strict locator.
3431
- * @returns automatically synchronized promise through #recorder
3432
3324
  */
3433
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
3325
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
3434
3326
  /**
3435
3327
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
3436
3328
  *
@@ -3438,9 +3330,8 @@ declare namespace CodeceptJS {
3438
3330
  * I.dontSeeElement('.modal'); // modal is not shown
3439
3331
  * ```
3440
3332
  * @param locator - located by CSS|XPath|Strict locator.
3441
- * @returns automatically synchronized promise through #recorder
3442
3333
  */
3443
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
3334
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
3444
3335
  /**
3445
3336
  * Checks that a given Element is present in the DOM
3446
3337
  * Element is located by CSS or XPath.
@@ -3449,9 +3340,8 @@ declare namespace CodeceptJS {
3449
3340
  * I.seeElementInDOM('#modal');
3450
3341
  * ```
3451
3342
  * @param locator - element located by CSS|XPath|strict locator.
3452
- * @returns automatically synchronized promise through #recorder
3453
3343
  */
3454
- seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
3344
+ seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
3455
3345
  /**
3456
3346
  * Opposite to `seeElementInDOM`. Checks that element is not on page.
3457
3347
  *
@@ -3459,9 +3349,8 @@ declare namespace CodeceptJS {
3459
3349
  * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
3460
3350
  * ```
3461
3351
  * @param locator - located by CSS|XPath|Strict locator.
3462
- * @returns automatically synchronized promise through #recorder
3463
3352
  */
3464
- dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
3353
+ dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
3465
3354
  /**
3466
3355
  * Handles a file download. A file name is required to save the file on disk.
3467
3356
  * Files are saved to "output" directory.
@@ -3513,9 +3402,8 @@ declare namespace CodeceptJS {
3513
3402
  * // make ctrl-click
3514
3403
  * I.click('.edit', null, { modifiers: ['Ctrl'] } )
3515
3404
  * ```
3516
- * @returns automatically synchronized promise through #recorder
3517
3405
  */
3518
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any): Promise<void>;
3406
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any): Promise<any>;
3519
3407
  /**
3520
3408
  * Clicks link and waits for navigation (deprecated)
3521
3409
  */
@@ -3547,9 +3435,8 @@ declare namespace CodeceptJS {
3547
3435
  * ```
3548
3436
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
3549
3437
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
3550
- * @returns automatically synchronized promise through #recorder
3551
3438
  */
3552
- forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
3439
+ forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
3553
3440
  /**
3554
3441
  * Performs a double-click on an element matched by link|button|label|CSS or XPath.
3555
3442
  * Context can be specified as second parameter to narrow search.
@@ -3562,9 +3449,8 @@ declare namespace CodeceptJS {
3562
3449
  * ```
3563
3450
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
3564
3451
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
3565
- * @returns automatically synchronized promise through #recorder
3566
3452
  */
3567
- doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
3453
+ doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
3568
3454
  /**
3569
3455
  * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
3570
3456
  *
@@ -3578,9 +3464,8 @@ declare namespace CodeceptJS {
3578
3464
  * ```
3579
3465
  * @param locator - clickable element located by CSS|XPath|strict locator.
3580
3466
  * @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
3581
- * @returns automatically synchronized promise through #recorder
3582
3467
  */
3583
- rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
3468
+ rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
3584
3469
  /**
3585
3470
  * Selects a checkbox or radio button.
3586
3471
  * Element is located by label or name or CSS or XPath.
@@ -3594,20 +3479,8 @@ declare namespace CodeceptJS {
3594
3479
  * ```
3595
3480
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
3596
3481
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
3597
- * @returns automatically synchronized promise through #recorder
3598
- *
3599
- *
3600
- * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-check) for check available as 3rd argument.
3601
- *
3602
- * Examples:
3603
- *
3604
- * ```js
3605
- * // click on element at position
3606
- * I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
3607
- * ```
3608
- * > ⚠️ To avoid flakiness, option `force: true` is set by default
3609
3482
  */
3610
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
3483
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
3611
3484
  /**
3612
3485
  * Unselects a checkbox or radio button.
3613
3486
  * Element is located by label or name or CSS or XPath.
@@ -3621,20 +3494,8 @@ declare namespace CodeceptJS {
3621
3494
  * ```
3622
3495
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
3623
3496
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
3624
- * @returns automatically synchronized promise through #recorder
3625
- *
3626
- *
3627
- * [Additional options](https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck) for uncheck available as 3rd argument.
3628
- *
3629
- * Examples:
3630
- *
3631
- * ```js
3632
- * // click on element at position
3633
- * I.uncheckOption('Agree', '.signup', { position: { x: 5, y: 5 } })
3634
- * ```
3635
- * > ⚠️ To avoid flakiness, option `force: true` is set by default
3636
3497
  */
3637
- uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
3498
+ uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
3638
3499
  /**
3639
3500
  * Verifies that the specified checkbox is checked.
3640
3501
  *
@@ -3644,9 +3505,8 @@ declare namespace CodeceptJS {
3644
3505
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
3645
3506
  * ```
3646
3507
  * @param field - located by label|name|CSS|XPath|strict locator.
3647
- * @returns automatically synchronized promise through #recorder
3648
3508
  */
3649
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
3509
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
3650
3510
  /**
3651
3511
  * Verifies that the specified checkbox is not checked.
3652
3512
  *
@@ -3656,9 +3516,8 @@ declare namespace CodeceptJS {
3656
3516
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
3657
3517
  * ```
3658
3518
  * @param field - located by label|name|CSS|XPath|strict locator.
3659
- * @returns automatically synchronized promise through #recorder
3660
3519
  */
3661
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
3520
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
3662
3521
  /**
3663
3522
  * Presses a key in the browser and leaves it in a down state.
3664
3523
  *
@@ -3670,9 +3529,8 @@ declare namespace CodeceptJS {
3670
3529
  * I.pressKeyUp('Control');
3671
3530
  * ```
3672
3531
  * @param key - name of key to press down.
3673
- * @returns automatically synchronized promise through #recorder
3674
3532
  */
3675
- pressKeyDown(key: string): Promise<void>;
3533
+ pressKeyDown(key: string): Promise<any>;
3676
3534
  /**
3677
3535
  * Releases a key in the browser which was previously set to a down state.
3678
3536
  *
@@ -3684,9 +3542,8 @@ declare namespace CodeceptJS {
3684
3542
  * I.pressKeyUp('Control');
3685
3543
  * ```
3686
3544
  * @param key - name of key to release.
3687
- * @returns automatically synchronized promise through #recorder
3688
3545
  */
3689
- pressKeyUp(key: string): Promise<void>;
3546
+ pressKeyUp(key: string): Promise<any>;
3690
3547
  /**
3691
3548
  * Presses a key in the browser (on a focused element).
3692
3549
  *
@@ -3746,12 +3603,8 @@ declare namespace CodeceptJS {
3746
3603
  * - `'Space'`
3747
3604
  * - `'Tab'`
3748
3605
  * @param key - key or array of keys to press.
3749
- * @returns automatically synchronized promise through #recorder
3750
- *
3751
- *
3752
- * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
3753
3606
  */
3754
- pressKey(key: string | string[]): Promise<void>;
3607
+ pressKey(key: string | string[]): Promise<any>;
3755
3608
  /**
3756
3609
  * Types out the given text into an active field.
3757
3610
  * To slow down typing use a second parameter, to set interval between key presses.
@@ -3772,9 +3625,8 @@ declare namespace CodeceptJS {
3772
3625
  * ```
3773
3626
  * @param key - or array of keys to type.
3774
3627
  * @param [delay = null] - (optional) delay in ms between key presses
3775
- * @returns automatically synchronized promise through #recorder
3776
3628
  */
3777
- type(key: string | string[], delay?: number): Promise<void>;
3629
+ type(key: string | string[], delay?: number): Promise<any>;
3778
3630
  /**
3779
3631
  * Fills a text field or textarea, after clearing its value, with the given string.
3780
3632
  * Field is located by name, label, CSS, or XPath.
@@ -3791,9 +3643,8 @@ declare namespace CodeceptJS {
3791
3643
  * ```
3792
3644
  * @param field - located by label|name|CSS|XPath|strict locator.
3793
3645
  * @param value - text value to fill.
3794
- * @returns automatically synchronized promise through #recorder
3795
3646
  */
3796
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
3647
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
3797
3648
  /**
3798
3649
  * Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .
3799
3650
  *
@@ -3822,9 +3673,8 @@ declare namespace CodeceptJS {
3822
3673
  * ```
3823
3674
  * @param field - located by label|name|CSS|XPath|strict locator
3824
3675
  * @param value - text value to append.
3825
- * @returns automatically synchronized promise through #recorder
3826
3676
  */
3827
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
3677
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
3828
3678
  /**
3829
3679
  * Checks that the given input field or textarea equals to given value.
3830
3680
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -3837,9 +3687,8 @@ declare namespace CodeceptJS {
3837
3687
  * ```
3838
3688
  * @param field - located by label|name|CSS|XPath|strict locator.
3839
3689
  * @param value - value to check.
3840
- * @returns automatically synchronized promise through #recorder
3841
3690
  */
3842
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
3691
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
3843
3692
  /**
3844
3693
  * Checks that value of input field or textarea doesn't equal to given value
3845
3694
  * Opposite to `seeInField`.
@@ -3850,9 +3699,8 @@ declare namespace CodeceptJS {
3850
3699
  * ```
3851
3700
  * @param field - located by label|name|CSS|XPath|strict locator.
3852
3701
  * @param value - value to check.
3853
- * @returns automatically synchronized promise through #recorder
3854
3702
  */
3855
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
3703
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
3856
3704
  /**
3857
3705
  * Attaches a file to element located by label, name, CSS or XPath
3858
3706
  * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -3864,9 +3712,8 @@ declare namespace CodeceptJS {
3864
3712
  * ```
3865
3713
  * @param locator - field located by label|name|CSS|XPath|strict locator.
3866
3714
  * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
3867
- * @returns automatically synchronized promise through #recorder
3868
3715
  */
3869
- attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<void>;
3716
+ attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
3870
3717
  /**
3871
3718
  * Selects an option in a drop-down select.
3872
3719
  * Field is searched by label | name | CSS | XPath.
@@ -3888,9 +3735,8 @@ declare namespace CodeceptJS {
3888
3735
  * ```
3889
3736
  * @param select - field located by label|name|CSS|XPath|strict locator.
3890
3737
  * @param option - visible text or value of option.
3891
- * @returns automatically synchronized promise through #recorder
3892
3738
  */
3893
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
3739
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
3894
3740
  /**
3895
3741
  * Grab number of visible elements by locator.
3896
3742
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -3909,15 +3755,13 @@ declare namespace CodeceptJS {
3909
3755
  * I.seeInCurrentUrl('/register'); // we are on registration page
3910
3756
  * ```
3911
3757
  * @param url - a fragment to check
3912
- * @returns automatically synchronized promise through #recorder
3913
3758
  */
3914
- seeInCurrentUrl(url: string): Promise<void>;
3759
+ seeInCurrentUrl(url: string): Promise<any>;
3915
3760
  /**
3916
3761
  * Checks that current url does not contain a provided fragment.
3917
3762
  * @param url - value to check.
3918
- * @returns automatically synchronized promise through #recorder
3919
3763
  */
3920
- dontSeeInCurrentUrl(url: string): Promise<void>;
3764
+ dontSeeInCurrentUrl(url: string): Promise<any>;
3921
3765
  /**
3922
3766
  * Checks that current url is equal to provided one.
3923
3767
  * If a relative url provided, a configured url will be prepended to it.
@@ -3928,9 +3772,8 @@ declare namespace CodeceptJS {
3928
3772
  * I.seeCurrentUrlEquals('http://my.site.com/register');
3929
3773
  * ```
3930
3774
  * @param url - value to check.
3931
- * @returns automatically synchronized promise through #recorder
3932
3775
  */
3933
- seeCurrentUrlEquals(url: string): Promise<void>;
3776
+ seeCurrentUrlEquals(url: string): Promise<any>;
3934
3777
  /**
3935
3778
  * Checks that current url is not equal to provided one.
3936
3779
  * If a relative url provided, a configured url will be prepended to it.
@@ -3940,9 +3783,8 @@ declare namespace CodeceptJS {
3940
3783
  * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
3941
3784
  * ```
3942
3785
  * @param url - value to check.
3943
- * @returns automatically synchronized promise through #recorder
3944
3786
  */
3945
- dontSeeCurrentUrlEquals(url: string): Promise<void>;
3787
+ dontSeeCurrentUrlEquals(url: string): Promise<any>;
3946
3788
  /**
3947
3789
  * Checks that a page contains a visible text.
3948
3790
  * Use context parameter to narrow down the search.
@@ -3954,9 +3796,8 @@ declare namespace CodeceptJS {
3954
3796
  * ```
3955
3797
  * @param text - expected on page.
3956
3798
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
3957
- * @returns automatically synchronized promise through #recorder
3958
3799
  */
3959
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
3800
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
3960
3801
  /**
3961
3802
  * Checks that text is equal to provided one.
3962
3803
  *
@@ -3965,9 +3806,8 @@ declare namespace CodeceptJS {
3965
3806
  * ```
3966
3807
  * @param text - element value to check.
3967
3808
  * @param [context = null] - element located by CSS|XPath|strict locator.
3968
- * @returns automatically synchronized promise through #recorder
3969
3809
  */
3970
- seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
3810
+ seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
3971
3811
  /**
3972
3812
  * Opposite to `see`. Checks that a text is not present on a page.
3973
3813
  * Use context parameter to narrow down the search.
@@ -3978,9 +3818,8 @@ declare namespace CodeceptJS {
3978
3818
  * ```
3979
3819
  * @param text - which is not present.
3980
3820
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
3981
- * @returns automatically synchronized promise through #recorder
3982
3821
  */
3983
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
3822
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
3984
3823
  /**
3985
3824
  * Retrieves page source and returns it to test.
3986
3825
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -4020,9 +3859,8 @@ declare namespace CodeceptJS {
4020
3859
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
4021
3860
  * ```
4022
3861
  * @param text - value to check.
4023
- * @returns automatically synchronized promise through #recorder
4024
3862
  */
4025
- seeInSource(text: string): Promise<void>;
3863
+ seeInSource(text: string): Promise<any>;
4026
3864
  /**
4027
3865
  * Checks that the current page does not contains the given string in its raw source code.
4028
3866
  *
@@ -4030,9 +3868,8 @@ declare namespace CodeceptJS {
4030
3868
  * I.dontSeeInSource('<!--'); // no comments in source
4031
3869
  * ```
4032
3870
  * @param value - to check.
4033
- * @returns automatically synchronized promise through #recorder
4034
3871
  */
4035
- dontSeeInSource(value: string): Promise<void>;
3872
+ dontSeeInSource(value: string): Promise<any>;
4036
3873
  /**
4037
3874
  * Asserts that an element appears a given number of times in the DOM.
4038
3875
  * Element is located by label or name or CSS or XPath.
@@ -4043,9 +3880,8 @@ declare namespace CodeceptJS {
4043
3880
  * ```
4044
3881
  * @param locator - element located by CSS|XPath|strict locator.
4045
3882
  * @param num - number of elements.
4046
- * @returns automatically synchronized promise through #recorder
4047
3883
  */
4048
- seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
3884
+ seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
4049
3885
  /**
4050
3886
  * Asserts that an element is visible a given number of times.
4051
3887
  * Element is located by CSS or XPath.
@@ -4055,9 +3891,8 @@ declare namespace CodeceptJS {
4055
3891
  * ```
4056
3892
  * @param locator - element located by CSS|XPath|strict locator.
4057
3893
  * @param num - number of elements.
4058
- * @returns automatically synchronized promise through #recorder
4059
3894
  */
4060
- seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
3895
+ seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
4061
3896
  /**
4062
3897
  * Sets cookie(s).
4063
3898
  *
@@ -4073,9 +3908,8 @@ declare namespace CodeceptJS {
4073
3908
  * ]);
4074
3909
  * ```
4075
3910
  * @param cookie - a cookie object or array of cookie objects.
4076
- * @returns automatically synchronized promise through #recorder
4077
3911
  */
4078
- setCookie(cookie: Cookie | Cookie[]): Promise<void>;
3912
+ setCookie(cookie: Cookie | Cookie[]): Promise<any>;
4079
3913
  /**
4080
3914
  * Checks that cookie with given name exists.
4081
3915
  *
@@ -4083,9 +3917,8 @@ declare namespace CodeceptJS {
4083
3917
  * I.seeCookie('Auth');
4084
3918
  * ```
4085
3919
  * @param name - cookie name.
4086
- * @returns automatically synchronized promise through #recorder
4087
3920
  */
4088
- seeCookie(name: string): Promise<void>;
3921
+ seeCookie(name: string): Promise<any>;
4089
3922
  /**
4090
3923
  * Checks that cookie with given name does not exist.
4091
3924
  *
@@ -4093,9 +3926,8 @@ declare namespace CodeceptJS {
4093
3926
  * I.dontSeeCookie('auth'); // no auth cookie
4094
3927
  * ```
4095
3928
  * @param name - cookie name.
4096
- * @returns automatically synchronized promise through #recorder
4097
3929
  */
4098
- dontSeeCookie(name: string): Promise<void>;
3930
+ dontSeeCookie(name: string): Promise<any>;
4099
3931
  /**
4100
3932
  * Gets a cookie object by name.
4101
3933
  * If none provided gets all cookies.
@@ -4114,12 +3946,11 @@ declare namespace CodeceptJS {
4114
3946
  *
4115
3947
  * ```js
4116
3948
  * I.clearCookie();
4117
- * I.clearCookie('test');
3949
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
4118
3950
  * ```
4119
3951
  * @param [cookie = null] - (optional, `null` by default) cookie name
4120
- * @returns automatically synchronized promise through #recorder
4121
3952
  */
4122
- clearCookie(cookie?: string): Promise<void>;
3953
+ clearCookie(cookie?: string): Promise<any>;
4123
3954
  /**
4124
3955
  * Executes a script on the page:
4125
3956
  *
@@ -4249,9 +4080,8 @@ declare namespace CodeceptJS {
4249
4080
  * ```
4250
4081
  * @param locator - located by CSS|XPath|strict locator.
4251
4082
  * @param cssProperties - object with CSS properties and their values to check.
4252
- * @returns automatically synchronized promise through #recorder
4253
4083
  */
4254
- seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<void>;
4084
+ seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<any>;
4255
4085
  /**
4256
4086
  * Checks that all elements with given locator have given attributes.
4257
4087
  *
@@ -4260,9 +4090,8 @@ declare namespace CodeceptJS {
4260
4090
  * ```
4261
4091
  * @param locator - located by CSS|XPath|strict locator.
4262
4092
  * @param attributes - attributes and their values to check.
4263
- * @returns automatically synchronized promise through #recorder
4264
4093
  */
4265
- seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<void>;
4094
+ seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<any>;
4266
4095
  /**
4267
4096
  * Drag the scrubber of a slider to a given position
4268
4097
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -4273,9 +4102,8 @@ declare namespace CodeceptJS {
4273
4102
  * ```
4274
4103
  * @param locator - located by label|name|CSS|XPath|strict locator.
4275
4104
  * @param offsetX - position to drag.
4276
- * @returns automatically synchronized promise through #recorder
4277
4105
  */
4278
- dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): Promise<void>;
4106
+ dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): Promise<any>;
4279
4107
  /**
4280
4108
  * Retrieves an attribute from an element located by CSS or XPath and returns it to test.
4281
4109
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -4310,9 +4138,8 @@ declare namespace CodeceptJS {
4310
4138
  * ```
4311
4139
  * @param locator - element located by CSS|XPath|strict locator.
4312
4140
  * @param fileName - file name to save.
4313
- * @returns automatically synchronized promise through #recorder
4314
4141
  */
4315
- saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<void>;
4142
+ saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<any>;
4316
4143
  /**
4317
4144
  * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
4318
4145
  * Filename is relative to output folder.
@@ -4324,9 +4151,8 @@ declare namespace CodeceptJS {
4324
4151
  * ```
4325
4152
  * @param fileName - file name to save.
4326
4153
  * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
4327
- * @returns automatically synchronized promise through #recorder
4328
4154
  */
4329
- saveScreenshot(fileName: string, fullPage?: boolean): Promise<void>;
4155
+ saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
4330
4156
  /**
4331
4157
  * Performs [api request](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get) using
4332
4158
  * the cookies from the current browser session.
@@ -4351,17 +4177,15 @@ declare namespace CodeceptJS {
4351
4177
  * I.wait(2); // wait 2 secs
4352
4178
  * ```
4353
4179
  * @param sec - number of second to wait.
4354
- * @returns automatically synchronized promise through #recorder
4355
4180
  */
4356
- wait(sec: number): Promise<void>;
4181
+ wait(sec: number): Promise<any>;
4357
4182
  /**
4358
4183
  * Waits for element to become enabled (by default waits for 1sec).
4359
4184
  * Element can be located by CSS or XPath.
4360
4185
  * @param locator - element located by CSS|XPath|strict locator.
4361
4186
  * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
4362
- * @returns automatically synchronized promise through #recorder
4363
4187
  */
4364
- waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4188
+ waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4365
4189
  /**
4366
4190
  * Waits for the specified value to be in value attribute.
4367
4191
  *
@@ -4371,9 +4195,8 @@ declare namespace CodeceptJS {
4371
4195
  * @param field - input field.
4372
4196
  * @param value - expected value.
4373
4197
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4374
- * @returns automatically synchronized promise through #recorder
4375
4198
  */
4376
- waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<void>;
4199
+ waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<any>;
4377
4200
  /**
4378
4201
  * Waits for a specified number of elements on the page.
4379
4202
  *
@@ -4383,9 +4206,8 @@ declare namespace CodeceptJS {
4383
4206
  * @param locator - element located by CSS|XPath|strict locator.
4384
4207
  * @param num - number of elements.
4385
4208
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4386
- * @returns automatically synchronized promise through #recorder
4387
4209
  */
4388
- waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<void>;
4210
+ waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<any>;
4389
4211
  /**
4390
4212
  * Waits for element to be clickable (by default waits for 1sec).
4391
4213
  * Element can be located by CSS or XPath.
@@ -4396,9 +4218,8 @@ declare namespace CodeceptJS {
4396
4218
  * ```
4397
4219
  * @param locator - element located by CSS|XPath|strict locator.
4398
4220
  * @param [sec] - (optional, `1` by default) time in seconds to wait
4399
- * @returns automatically synchronized promise through #recorder
4400
4221
  */
4401
- waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4222
+ waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4402
4223
  /**
4403
4224
  * Waits for element to be present on page (by default waits for 1sec).
4404
4225
  * Element can be located by CSS or XPath.
@@ -4409,9 +4230,8 @@ declare namespace CodeceptJS {
4409
4230
  * ```
4410
4231
  * @param locator - element located by CSS|XPath|strict locator.
4411
4232
  * @param [sec] - (optional, `1` by default) time in seconds to wait
4412
- * @returns automatically synchronized promise through #recorder
4413
4233
  */
4414
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4234
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4415
4235
  /**
4416
4236
  * Waits for an element to become visible on a page (by default waits for 1sec).
4417
4237
  * Element can be located by CSS or XPath.
@@ -4421,12 +4241,8 @@ declare namespace CodeceptJS {
4421
4241
  * ```
4422
4242
  * @param locator - element located by CSS|XPath|strict locator.
4423
4243
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4424
- * @returns automatically synchronized promise through #recorder
4425
- *
4426
- *
4427
- * This method accepts [React selectors](https://codecept.io/react).
4428
4244
  */
4429
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4245
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4430
4246
  /**
4431
4247
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
4432
4248
  * Element can be located by CSS or XPath.
@@ -4436,9 +4252,8 @@ declare namespace CodeceptJS {
4436
4252
  * ```
4437
4253
  * @param locator - element located by CSS|XPath|strict locator.
4438
4254
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4439
- * @returns automatically synchronized promise through #recorder
4440
4255
  */
4441
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4256
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4442
4257
  /**
4443
4258
  * Waits for an element to hide (by default waits for 1sec).
4444
4259
  * Element can be located by CSS or XPath.
@@ -4448,9 +4263,8 @@ declare namespace CodeceptJS {
4448
4263
  * ```
4449
4264
  * @param locator - element located by CSS|XPath|strict locator.
4450
4265
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4451
- * @returns automatically synchronized promise through #recorder
4452
4266
  */
4453
- waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4267
+ waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4454
4268
  /**
4455
4269
  * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
4456
4270
  *
@@ -4459,9 +4273,8 @@ declare namespace CodeceptJS {
4459
4273
  * ```
4460
4274
  * @param urlPart - value to check.
4461
4275
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4462
- * @returns automatically synchronized promise through #recorder
4463
4276
  */
4464
- waitInUrl(urlPart: string, sec?: number): Promise<void>;
4277
+ waitInUrl(urlPart: string, sec?: number): Promise<any>;
4465
4278
  /**
4466
4279
  * Waits for the entire URL to match the expected
4467
4280
  *
@@ -4471,9 +4284,8 @@ declare namespace CodeceptJS {
4471
4284
  * ```
4472
4285
  * @param urlPart - value to check.
4473
4286
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4474
- * @returns automatically synchronized promise through #recorder
4475
4287
  */
4476
- waitUrlEquals(urlPart: string, sec?: number): Promise<void>;
4288
+ waitUrlEquals(urlPart: string, sec?: number): Promise<any>;
4477
4289
  /**
4478
4290
  * Waits for a text to appear (by default waits for 1sec).
4479
4291
  * Element can be located by CSS or XPath.
@@ -4486,9 +4298,8 @@ declare namespace CodeceptJS {
4486
4298
  * @param text - to wait for.
4487
4299
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4488
4300
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
4489
- * @returns automatically synchronized promise through #recorder
4490
4301
  */
4491
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
4302
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
4492
4303
  /**
4493
4304
  * Waits for a network request.
4494
4305
  *
@@ -4517,9 +4328,8 @@ declare namespace CodeceptJS {
4517
4328
  * I.switchTo(); // switch back to main page
4518
4329
  * ```
4519
4330
  * @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
4520
- * @returns automatically synchronized promise through #recorder
4521
4331
  */
4522
- switchTo(locator?: CodeceptJS.LocatorOrString): Promise<void>;
4332
+ switchTo(locator?: CodeceptJS.LocatorOrString): Promise<any>;
4523
4333
  /**
4524
4334
  * Waits for a function to return true (waits for 1 sec by default).
4525
4335
  * Running in browser context.
@@ -4536,9 +4346,8 @@ declare namespace CodeceptJS {
4536
4346
  * @param fn - to be executed in browser context.
4537
4347
  * @param [argsOrSec = null] - (optional, `1` by default) arguments for function or seconds.
4538
4348
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
4539
- * @returns automatically synchronized promise through #recorder
4540
4349
  */
4541
- waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<void>;
4350
+ waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
4542
4351
  /**
4543
4352
  * Waits for navigation to finish. By default, it takes configured `waitForNavigation` option.
4544
4353
  *
@@ -4561,9 +4370,8 @@ declare namespace CodeceptJS {
4561
4370
  * ```
4562
4371
  * @param locator - element located by CSS|XPath|strict locator.
4563
4372
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
4564
- * @returns automatically synchronized promise through #recorder
4565
4373
  */
4566
- waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
4374
+ waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
4567
4375
  /**
4568
4376
  * Grab the data from performance timing using Navigation Timing API.
4569
4377
  * The returned data will contain following things in ms:
@@ -4584,9 +4392,8 @@ declare namespace CodeceptJS {
4584
4392
  * loadEventEnd: 241
4585
4393
  * }
4586
4394
  * ```
4587
- * @returns automatically synchronized promise through #recorder
4588
4395
  */
4589
- grabDataFromPerformanceTiming(): Promise<void>;
4396
+ grabDataFromPerformanceTiming(): Promise<any>;
4590
4397
  /**
4591
4398
  * Grab the width, height, location of given locator.
4592
4399
  * Provide `width` or `height`as second param to get your desired prop.
@@ -5015,9 +4822,8 @@ declare namespace CodeceptJS {
5015
4822
  * I.amOnPage('/login'); // opens a login page
5016
4823
  * ```
5017
4824
  * @param url - url path or global url.
5018
- * @returns automatically synchronized promise through #recorder
5019
4825
  */
5020
- amOnPage(url: string): Promise<void>;
4826
+ amOnPage(url: string): Promise<any>;
5021
4827
  /**
5022
4828
  * Perform a click on a link or a button, given by a locator.
5023
4829
  * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -5042,9 +4848,8 @@ declare namespace CodeceptJS {
5042
4848
  * ```
5043
4849
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
5044
4850
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
5045
- * @returns automatically synchronized promise through #recorder
5046
4851
  */
5047
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<void>;
4852
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<any>;
5048
4853
  /**
5049
4854
  * Performs a double-click on an element matched by link|button|label|CSS or XPath.
5050
4855
  * Context can be specified as second parameter to narrow search.
@@ -5057,9 +4862,8 @@ declare namespace CodeceptJS {
5057
4862
  * ```
5058
4863
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
5059
4864
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
5060
- * @returns automatically synchronized promise through #recorder
5061
4865
  */
5062
- doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
4866
+ doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
5063
4867
  /**
5064
4868
  * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
5065
4869
  *
@@ -5073,9 +4877,8 @@ declare namespace CodeceptJS {
5073
4877
  * ```
5074
4878
  * @param locator - clickable element located by CSS|XPath|strict locator.
5075
4879
  * @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
5076
- * @returns automatically synchronized promise through #recorder
5077
4880
  */
5078
- rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
4881
+ rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
5079
4882
  /**
5080
4883
  * Moves cursor to element matched by locator.
5081
4884
  * Extra shift can be set with offsetX and offsetY options.
@@ -5087,9 +4890,8 @@ declare namespace CodeceptJS {
5087
4890
  * @param locator - located by CSS|XPath|strict locator.
5088
4891
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
5089
4892
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
5090
- * @returns automatically synchronized promise through #recorder
5091
4893
  */
5092
- moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
4894
+ moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
5093
4895
  /**
5094
4896
  * Checks that a page contains a visible text.
5095
4897
  * Use context parameter to narrow down the search.
@@ -5101,9 +4903,8 @@ declare namespace CodeceptJS {
5101
4903
  * ```
5102
4904
  * @param text - expected on page.
5103
4905
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
5104
- * @returns automatically synchronized promise through #recorder
5105
4906
  */
5106
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
4907
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
5107
4908
  /**
5108
4909
  * Checks that text is equal to provided one.
5109
4910
  *
@@ -5112,9 +4913,8 @@ declare namespace CodeceptJS {
5112
4913
  * ```
5113
4914
  * @param text - element value to check.
5114
4915
  * @param [context = null] - element located by CSS|XPath|strict locator.
5115
- * @returns automatically synchronized promise through #recorder
5116
4916
  */
5117
- seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
4917
+ seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
5118
4918
  /**
5119
4919
  * Opposite to `see`. Checks that a text is not present on a page.
5120
4920
  * Use context parameter to narrow down the search.
@@ -5125,9 +4925,8 @@ declare namespace CodeceptJS {
5125
4925
  * ```
5126
4926
  * @param text - which is not present.
5127
4927
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
5128
- * @returns automatically synchronized promise through #recorder
5129
4928
  */
5130
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
4929
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
5131
4930
  /**
5132
4931
  * Get JS log from browser. Log buffer is reset after each request.
5133
4932
  * Resumes test execution, so **should be used inside an async function with `await`** operator.
@@ -5171,9 +4970,8 @@ declare namespace CodeceptJS {
5171
4970
  * ```
5172
4971
  * @param select - field located by label|name|CSS|XPath|strict locator.
5173
4972
  * @param option - visible text or value of option.
5174
- * @returns automatically synchronized promise through #recorder
5175
4973
  */
5176
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
4974
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
5177
4975
  /**
5178
4976
  * Fills a text field or textarea, after clearing its value, with the given string.
5179
4977
  * Field is located by name, label, CSS, or XPath.
@@ -5190,9 +4988,8 @@ declare namespace CodeceptJS {
5190
4988
  * ```
5191
4989
  * @param field - located by label|name|CSS|XPath|strict locator.
5192
4990
  * @param value - text value to fill.
5193
- * @returns automatically synchronized promise through #recorder
5194
4991
  */
5195
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
4992
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
5196
4993
  /**
5197
4994
  * Presses a key on a focused element.
5198
4995
  * Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
@@ -5204,11 +5001,8 @@ declare namespace CodeceptJS {
5204
5001
  * I.pressKey(['Control','a']);
5205
5002
  * ```
5206
5003
  * @param key - key or array of keys to press.
5207
- * @returns automatically synchronized promise through #recorder
5208
- *
5209
- * {{ keys }}
5210
5004
  */
5211
- pressKey(key: string | string[]): Promise<void>;
5005
+ pressKey(key: string | string[]): Promise<any>;
5212
5006
  /**
5213
5007
  * Attaches a file to element located by label, name, CSS or XPath
5214
5008
  * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -5220,9 +5014,8 @@ declare namespace CodeceptJS {
5220
5014
  * ```
5221
5015
  * @param locator - field located by label|name|CSS|XPath|strict locator.
5222
5016
  * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
5223
- * @returns automatically synchronized promise through #recorder
5224
5017
  */
5225
- attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<void>;
5018
+ attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
5226
5019
  /**
5227
5020
  * Checks that the given input field or textarea equals to given value.
5228
5021
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -5235,9 +5028,8 @@ declare namespace CodeceptJS {
5235
5028
  * ```
5236
5029
  * @param field - located by label|name|CSS|XPath|strict locator.
5237
5030
  * @param value - value to check.
5238
- * @returns automatically synchronized promise through #recorder
5239
5031
  */
5240
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
5032
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
5241
5033
  /**
5242
5034
  * Checks that value of input field or textarea doesn't equal to given value
5243
5035
  * Opposite to `seeInField`.
@@ -5248,9 +5040,8 @@ declare namespace CodeceptJS {
5248
5040
  * ```
5249
5041
  * @param field - located by label|name|CSS|XPath|strict locator.
5250
5042
  * @param value - value to check.
5251
- * @returns automatically synchronized promise through #recorder
5252
5043
  */
5253
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
5044
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
5254
5045
  /**
5255
5046
  * Appends text to a input field or textarea.
5256
5047
  * Field is located by name, label, CSS or XPath
@@ -5262,9 +5053,8 @@ declare namespace CodeceptJS {
5262
5053
  * ```
5263
5054
  * @param field - located by label|name|CSS|XPath|strict locator
5264
5055
  * @param value - text value to append.
5265
- * @returns automatically synchronized promise through #recorder
5266
5056
  */
5267
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
5057
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
5268
5058
  /**
5269
5059
  * Clears a `<textarea>` or text `<input>` element's value.
5270
5060
  *
@@ -5274,9 +5064,8 @@ declare namespace CodeceptJS {
5274
5064
  * I.clearField('#email');
5275
5065
  * ```
5276
5066
  * @param editable - field located by label|name|CSS|XPath|strict locator.
5277
- * @returns automatically synchronized promise through #recorder.
5278
5067
  */
5279
- clearField(editable: LocatorOrString): Promise<void>;
5068
+ clearField(editable: LocatorOrString): Promise<any>;
5280
5069
  /**
5281
5070
  * Selects a checkbox or radio button.
5282
5071
  * Element is located by label or name or CSS or XPath.
@@ -5290,9 +5079,8 @@ declare namespace CodeceptJS {
5290
5079
  * ```
5291
5080
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
5292
5081
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
5293
- * @returns automatically synchronized promise through #recorder
5294
5082
  */
5295
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
5083
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
5296
5084
  /**
5297
5085
  * Unselects a checkbox or radio button.
5298
5086
  * Element is located by label or name or CSS or XPath.
@@ -5306,9 +5094,8 @@ declare namespace CodeceptJS {
5306
5094
  * ```
5307
5095
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
5308
5096
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
5309
- * @returns automatically synchronized promise through #recorder
5310
5097
  */
5311
- uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
5098
+ uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
5312
5099
  /**
5313
5100
  * Verifies that the specified checkbox is checked.
5314
5101
  *
@@ -5318,9 +5105,8 @@ declare namespace CodeceptJS {
5318
5105
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
5319
5106
  * ```
5320
5107
  * @param field - located by label|name|CSS|XPath|strict locator.
5321
- * @returns automatically synchronized promise through #recorder
5322
5108
  */
5323
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
5109
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
5324
5110
  /**
5325
5111
  * Verifies that the specified checkbox is not checked.
5326
5112
  *
@@ -5330,9 +5116,8 @@ declare namespace CodeceptJS {
5330
5116
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
5331
5117
  * ```
5332
5118
  * @param field - located by label|name|CSS|XPath|strict locator.
5333
- * @returns automatically synchronized promise through #recorder
5334
5119
  */
5335
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
5120
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
5336
5121
  /**
5337
5122
  * Retrieves all texts from an element located by CSS or XPath and returns it to test.
5338
5123
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -5459,9 +5244,8 @@ declare namespace CodeceptJS {
5459
5244
  * I.seeInTitle('Home Page');
5460
5245
  * ```
5461
5246
  * @param text - text value to check.
5462
- * @returns automatically synchronized promise through #recorder
5463
5247
  */
5464
- seeInTitle(text: string): Promise<void>;
5248
+ seeInTitle(text: string): Promise<any>;
5465
5249
  /**
5466
5250
  * Checks that title is equal to provided one.
5467
5251
  *
@@ -5469,9 +5253,8 @@ declare namespace CodeceptJS {
5469
5253
  * I.seeTitleEquals('Test title.');
5470
5254
  * ```
5471
5255
  * @param text - value to check.
5472
- * @returns automatically synchronized promise through #recorder
5473
5256
  */
5474
- seeTitleEquals(text: string): Promise<void>;
5257
+ seeTitleEquals(text: string): Promise<any>;
5475
5258
  /**
5476
5259
  * Checks that title does not contain text.
5477
5260
  *
@@ -5479,9 +5262,8 @@ declare namespace CodeceptJS {
5479
5262
  * I.dontSeeInTitle('Error');
5480
5263
  * ```
5481
5264
  * @param text - value to check.
5482
- * @returns automatically synchronized promise through #recorder
5483
5265
  */
5484
- dontSeeInTitle(text: string): Promise<void>;
5266
+ dontSeeInTitle(text: string): Promise<any>;
5485
5267
  /**
5486
5268
  * Retrieves a page title and returns it to test.
5487
5269
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -5500,9 +5282,8 @@ declare namespace CodeceptJS {
5500
5282
  * I.seeElement('#modal');
5501
5283
  * ```
5502
5284
  * @param locator - located by CSS|XPath|strict locator.
5503
- * @returns automatically synchronized promise through #recorder
5504
5285
  */
5505
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
5286
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
5506
5287
  /**
5507
5288
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
5508
5289
  *
@@ -5510,9 +5291,8 @@ declare namespace CodeceptJS {
5510
5291
  * I.dontSeeElement('.modal'); // modal is not shown
5511
5292
  * ```
5512
5293
  * @param locator - located by CSS|XPath|Strict locator.
5513
- * @returns automatically synchronized promise through #recorder
5514
5294
  */
5515
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
5295
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
5516
5296
  /**
5517
5297
  * Checks that a given Element is present in the DOM
5518
5298
  * Element is located by CSS or XPath.
@@ -5521,9 +5301,8 @@ declare namespace CodeceptJS {
5521
5301
  * I.seeElementInDOM('#modal');
5522
5302
  * ```
5523
5303
  * @param locator - element located by CSS|XPath|strict locator.
5524
- * @returns automatically synchronized promise through #recorder
5525
5304
  */
5526
- seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
5305
+ seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
5527
5306
  /**
5528
5307
  * Opposite to `seeElementInDOM`. Checks that element is not on page.
5529
5308
  *
@@ -5531,9 +5310,8 @@ declare namespace CodeceptJS {
5531
5310
  * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
5532
5311
  * ```
5533
5312
  * @param locator - located by CSS|XPath|Strict locator.
5534
- * @returns automatically synchronized promise through #recorder
5535
5313
  */
5536
- dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
5314
+ dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
5537
5315
  /**
5538
5316
  * Checks that the current page contains the given string in its raw source code.
5539
5317
  *
@@ -5541,9 +5319,8 @@ declare namespace CodeceptJS {
5541
5319
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
5542
5320
  * ```
5543
5321
  * @param text - value to check.
5544
- * @returns automatically synchronized promise through #recorder
5545
5322
  */
5546
- seeInSource(text: string): Promise<void>;
5323
+ seeInSource(text: string): Promise<any>;
5547
5324
  /**
5548
5325
  * Retrieves page source and returns it to test.
5549
5326
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -5561,9 +5338,8 @@ declare namespace CodeceptJS {
5561
5338
  * I.dontSeeInSource('<!--'); // no comments in source
5562
5339
  * ```
5563
5340
  * @param value - to check.
5564
- * @returns automatically synchronized promise through #recorder
5565
5341
  */
5566
- dontSeeInSource(value: string): Promise<void>;
5342
+ dontSeeInSource(value: string): Promise<any>;
5567
5343
  /**
5568
5344
  * Asserts that an element appears a given number of times in the DOM.
5569
5345
  * Element is located by label or name or CSS or XPath.
@@ -5574,9 +5350,8 @@ declare namespace CodeceptJS {
5574
5350
  * ```
5575
5351
  * @param locator - element located by CSS|XPath|strict locator.
5576
5352
  * @param num - number of elements.
5577
- * @returns automatically synchronized promise through #recorder
5578
5353
  */
5579
- seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
5354
+ seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
5580
5355
  /**
5581
5356
  * Asserts that an element is visible a given number of times.
5582
5357
  * Element is located by CSS or XPath.
@@ -5586,9 +5361,8 @@ declare namespace CodeceptJS {
5586
5361
  * ```
5587
5362
  * @param locator - element located by CSS|XPath|strict locator.
5588
5363
  * @param num - number of elements.
5589
- * @returns automatically synchronized promise through #recorder
5590
5364
  */
5591
- seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
5365
+ seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
5592
5366
  /**
5593
5367
  * Grab number of visible elements by locator.
5594
5368
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -5608,9 +5382,8 @@ declare namespace CodeceptJS {
5608
5382
  * ```
5609
5383
  * @param locator - located by CSS|XPath|strict locator.
5610
5384
  * @param cssProperties - object with CSS properties and their values to check.
5611
- * @returns automatically synchronized promise through #recorder
5612
5385
  */
5613
- seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<void>;
5386
+ seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<any>;
5614
5387
  /**
5615
5388
  * Checks that all elements with given locator have given attributes.
5616
5389
  *
@@ -5619,9 +5392,8 @@ declare namespace CodeceptJS {
5619
5392
  * ```
5620
5393
  * @param locator - located by CSS|XPath|strict locator.
5621
5394
  * @param attributes - attributes and their values to check.
5622
- * @returns automatically synchronized promise through #recorder
5623
5395
  */
5624
- seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<void>;
5396
+ seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<any>;
5625
5397
  /**
5626
5398
  * Executes sync script on a page.
5627
5399
  * Pass arguments to function as additional parameters.
@@ -5683,15 +5455,13 @@ declare namespace CodeceptJS {
5683
5455
  * I.seeInCurrentUrl('/register'); // we are on registration page
5684
5456
  * ```
5685
5457
  * @param url - a fragment to check
5686
- * @returns automatically synchronized promise through #recorder
5687
5458
  */
5688
- seeInCurrentUrl(url: string): Promise<void>;
5459
+ seeInCurrentUrl(url: string): Promise<any>;
5689
5460
  /**
5690
5461
  * Checks that current url does not contain a provided fragment.
5691
5462
  * @param url - value to check.
5692
- * @returns automatically synchronized promise through #recorder
5693
5463
  */
5694
- dontSeeInCurrentUrl(url: string): Promise<void>;
5464
+ dontSeeInCurrentUrl(url: string): Promise<any>;
5695
5465
  /**
5696
5466
  * Checks that current url is equal to provided one.
5697
5467
  * If a relative url provided, a configured url will be prepended to it.
@@ -5702,9 +5472,8 @@ declare namespace CodeceptJS {
5702
5472
  * I.seeCurrentUrlEquals('http://my.site.com/register');
5703
5473
  * ```
5704
5474
  * @param url - value to check.
5705
- * @returns automatically synchronized promise through #recorder
5706
5475
  */
5707
- seeCurrentUrlEquals(url: string): Promise<void>;
5476
+ seeCurrentUrlEquals(url: string): Promise<any>;
5708
5477
  /**
5709
5478
  * Checks that current url is not equal to provided one.
5710
5479
  * If a relative url provided, a configured url will be prepended to it.
@@ -5714,9 +5483,8 @@ declare namespace CodeceptJS {
5714
5483
  * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
5715
5484
  * ```
5716
5485
  * @param url - value to check.
5717
- * @returns automatically synchronized promise through #recorder
5718
5486
  */
5719
- dontSeeCurrentUrlEquals(url: string): Promise<void>;
5487
+ dontSeeCurrentUrlEquals(url: string): Promise<any>;
5720
5488
  /**
5721
5489
  * Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
5722
5490
  * Filename is relative to output folder.
@@ -5726,9 +5494,8 @@ declare namespace CodeceptJS {
5726
5494
  * ```
5727
5495
  * @param locator - element located by CSS|XPath|strict locator.
5728
5496
  * @param fileName - file name to save.
5729
- * @returns automatically synchronized promise through #recorder
5730
5497
  */
5731
- saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<void>;
5498
+ saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<any>;
5732
5499
  /**
5733
5500
  * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
5734
5501
  * Filename is relative to output folder.
@@ -5740,21 +5507,19 @@ declare namespace CodeceptJS {
5740
5507
  * ```
5741
5508
  * @param fileName - file name to save.
5742
5509
  * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
5743
- * @returns automatically synchronized promise through #recorder
5744
5510
  */
5745
- saveScreenshot(fileName: string, fullPage?: boolean): Promise<void>;
5511
+ saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
5746
5512
  /**
5747
5513
  * Clears a cookie by name,
5748
5514
  * if none provided clears all cookies.
5749
5515
  *
5750
5516
  * ```js
5751
5517
  * I.clearCookie();
5752
- * I.clearCookie('test');
5518
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
5753
5519
  * ```
5754
5520
  * @param [cookie = null] - (optional, `null` by default) cookie name
5755
- * @returns automatically synchronized promise through #recorder
5756
5521
  */
5757
- clearCookie(cookie?: string): Promise<void>;
5522
+ clearCookie(cookie?: string): Promise<any>;
5758
5523
  /**
5759
5524
  * Checks that cookie with given name exists.
5760
5525
  *
@@ -5762,9 +5527,8 @@ declare namespace CodeceptJS {
5762
5527
  * I.seeCookie('Auth');
5763
5528
  * ```
5764
5529
  * @param name - cookie name.
5765
- * @returns automatically synchronized promise through #recorder
5766
5530
  */
5767
- seeCookie(name: string): Promise<void>;
5531
+ seeCookie(name: string): Promise<any>;
5768
5532
  /**
5769
5533
  * Checks that cookie with given name does not exist.
5770
5534
  *
@@ -5772,9 +5536,8 @@ declare namespace CodeceptJS {
5772
5536
  * I.dontSeeCookie('auth'); // no auth cookie
5773
5537
  * ```
5774
5538
  * @param name - cookie name.
5775
- * @returns automatically synchronized promise through #recorder
5776
5539
  */
5777
- dontSeeCookie(name: string): Promise<void>;
5540
+ dontSeeCookie(name: string): Promise<any>;
5778
5541
  /**
5779
5542
  * Gets a cookie object by name.
5780
5543
  * If none provided gets all cookies.
@@ -5805,9 +5568,8 @@ declare namespace CodeceptJS {
5805
5568
  * I.seeInPopup('Popup text');
5806
5569
  * ```
5807
5570
  * @param text - value to check.
5808
- * @returns automatically synchronized promise through #recorder
5809
5571
  */
5810
- seeInPopup(text: string): Promise<void>;
5572
+ seeInPopup(text: string): Promise<any>;
5811
5573
  /**
5812
5574
  * Grab the text within the popup. If no popup is visible then it will return null
5813
5575
  *
@@ -5821,9 +5583,8 @@ declare namespace CodeceptJS {
5821
5583
  * First parameter can be set to `maximize`.
5822
5584
  * @param width - width in pixels or `maximize`.
5823
5585
  * @param height - height in pixels.
5824
- * @returns automatically synchronized promise through #recorder
5825
5586
  */
5826
- resizeWindow(width: number, height: number): Promise<void>;
5587
+ resizeWindow(width: number, height: number): Promise<any>;
5827
5588
  /**
5828
5589
  * Drag an item to a destination element.
5829
5590
  *
@@ -5832,9 +5593,8 @@ declare namespace CodeceptJS {
5832
5593
  * ```
5833
5594
  * @param srcElement - located by CSS|XPath|strict locator.
5834
5595
  * @param destElement - located by CSS|XPath|strict locator.
5835
- * @returns automatically synchronized promise through #recorder
5836
5596
  */
5837
- dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): Promise<void>;
5597
+ dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): Promise<any>;
5838
5598
  /**
5839
5599
  * Close all tabs except for the current one.
5840
5600
  *
@@ -5900,9 +5660,8 @@ declare namespace CodeceptJS {
5900
5660
  * I.switchTo(); // switch back to main page
5901
5661
  * ```
5902
5662
  * @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
5903
- * @returns automatically synchronized promise through #recorder
5904
5663
  */
5905
- switchTo(locator?: CodeceptJS.LocatorOrString): Promise<void>;
5664
+ switchTo(locator?: CodeceptJS.LocatorOrString): Promise<any>;
5906
5665
  /**
5907
5666
  * Pauses execution for a number of seconds.
5908
5667
  *
@@ -5910,9 +5669,8 @@ declare namespace CodeceptJS {
5910
5669
  * I.wait(2); // wait 2 secs
5911
5670
  * ```
5912
5671
  * @param sec - number of second to wait.
5913
- * @returns automatically synchronized promise through #recorder
5914
5672
  */
5915
- wait(sec: number): Promise<void>;
5673
+ wait(sec: number): Promise<any>;
5916
5674
  /**
5917
5675
  * Waits for element to be present on page (by default waits for 1sec).
5918
5676
  * Element can be located by CSS or XPath.
@@ -5923,9 +5681,8 @@ declare namespace CodeceptJS {
5923
5681
  * ```
5924
5682
  * @param locator - element located by CSS|XPath|strict locator.
5925
5683
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
5926
- * @returns automatically synchronized promise through #recorder
5927
5684
  */
5928
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
5685
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
5929
5686
  /**
5930
5687
  * Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
5931
5688
  * Element can be located by CSS or XPath.
@@ -5935,9 +5692,8 @@ declare namespace CodeceptJS {
5935
5692
  * ```
5936
5693
  * @param locator - element located by CSS|XPath|strict locator.
5937
5694
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
5938
- * @returns automatically synchronized promise through #recorder
5939
5695
  */
5940
- waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
5696
+ waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
5941
5697
  /**
5942
5698
  * Waits for element to become clickable for number of seconds.
5943
5699
  *
@@ -5955,9 +5711,8 @@ declare namespace CodeceptJS {
5955
5711
  * ```
5956
5712
  * @param locator - element located by CSS|XPath|strict locator.
5957
5713
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
5958
- * @returns automatically synchronized promise through #recorder
5959
5714
  */
5960
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
5715
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
5961
5716
  /**
5962
5717
  * Waits for an element to hide (by default waits for 1sec).
5963
5718
  * Element can be located by CSS or XPath.
@@ -5967,9 +5722,8 @@ declare namespace CodeceptJS {
5967
5722
  * ```
5968
5723
  * @param locator - element located by CSS|XPath|strict locator.
5969
5724
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
5970
- * @returns automatically synchronized promise through #recorder
5971
5725
  */
5972
- waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
5726
+ waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
5973
5727
  /**
5974
5728
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
5975
5729
  * Element can be located by CSS or XPath.
@@ -5979,9 +5733,8 @@ declare namespace CodeceptJS {
5979
5733
  * ```
5980
5734
  * @param locator - element located by CSS|XPath|strict locator.
5981
5735
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
5982
- * @returns automatically synchronized promise through #recorder
5983
5736
  */
5984
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
5737
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
5985
5738
  /**
5986
5739
  * Waits for a specified number of elements on the page.
5987
5740
  *
@@ -5991,17 +5744,15 @@ declare namespace CodeceptJS {
5991
5744
  * @param locator - element located by CSS|XPath|strict locator.
5992
5745
  * @param num - number of elements.
5993
5746
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
5994
- * @returns automatically synchronized promise through #recorder
5995
5747
  */
5996
- waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<void>;
5748
+ waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<any>;
5997
5749
  /**
5998
5750
  * Waits for element to become enabled (by default waits for 1sec).
5999
5751
  * Element can be located by CSS or XPath.
6000
5752
  * @param locator - element located by CSS|XPath|strict locator.
6001
5753
  * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
6002
- * @returns automatically synchronized promise through #recorder
6003
5754
  */
6004
- waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
5755
+ waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
6005
5756
  /**
6006
5757
  * Waits for the specified value to be in value attribute.
6007
5758
  *
@@ -6011,9 +5762,8 @@ declare namespace CodeceptJS {
6011
5762
  * @param field - input field.
6012
5763
  * @param value - expected value.
6013
5764
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
6014
- * @returns automatically synchronized promise through #recorder
6015
5765
  */
6016
- waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<void>;
5766
+ waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<any>;
6017
5767
  /**
6018
5768
  * Waits for a function to return true (waits for 1 sec by default).
6019
5769
  * Running in browser context.
@@ -6030,9 +5780,8 @@ declare namespace CodeceptJS {
6030
5780
  * @param fn - to be executed in browser context.
6031
5781
  * @param [argsOrSec = null] - (optional, `1` by default) arguments for function or seconds.
6032
5782
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
6033
- * @returns automatically synchronized promise through #recorder
6034
5783
  */
6035
- waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<void>;
5784
+ waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
6036
5785
  /**
6037
5786
  * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
6038
5787
  *
@@ -6041,9 +5790,8 @@ declare namespace CodeceptJS {
6041
5790
  * ```
6042
5791
  * @param urlPart - value to check.
6043
5792
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
6044
- * @returns automatically synchronized promise through #recorder
6045
5793
  */
6046
- waitInUrl(urlPart: string, sec?: number): Promise<void>;
5794
+ waitInUrl(urlPart: string, sec?: number): Promise<any>;
6047
5795
  /**
6048
5796
  * Waits for the entire URL to match the expected
6049
5797
  *
@@ -6053,9 +5801,8 @@ declare namespace CodeceptJS {
6053
5801
  * ```
6054
5802
  * @param urlPart - value to check.
6055
5803
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
6056
- * @returns automatically synchronized promise through #recorder
6057
5804
  */
6058
- waitUrlEquals(urlPart: string, sec?: number): Promise<void>;
5805
+ waitUrlEquals(urlPart: string, sec?: number): Promise<any>;
6059
5806
  /**
6060
5807
  * Waits for a text to appear (by default waits for 1sec).
6061
5808
  * Element can be located by CSS or XPath.
@@ -6068,9 +5815,8 @@ declare namespace CodeceptJS {
6068
5815
  * @param text - to wait for.
6069
5816
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
6070
5817
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
6071
- * @returns automatically synchronized promise through #recorder
6072
5818
  */
6073
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
5819
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
6074
5820
  /**
6075
5821
  * Moves to url
6076
5822
  */
@@ -6081,9 +5827,8 @@ declare namespace CodeceptJS {
6081
5827
  * ```js
6082
5828
  * I.refreshPage();
6083
5829
  * ```
6084
- * @returns automatically synchronized promise through #recorder
6085
5830
  */
6086
- refreshPage(): Promise<void>;
5831
+ refreshPage(): Promise<any>;
6087
5832
  /**
6088
5833
  * Reloads page
6089
5834
  */
@@ -6099,27 +5844,24 @@ declare namespace CodeceptJS {
6099
5844
  * @param locator - located by CSS|XPath|strict locator.
6100
5845
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
6101
5846
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
6102
- * @returns automatically synchronized promise through #recorder
6103
5847
  */
6104
- scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
5848
+ scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
6105
5849
  /**
6106
5850
  * Scroll page to the top.
6107
5851
  *
6108
5852
  * ```js
6109
5853
  * I.scrollPageToTop();
6110
5854
  * ```
6111
- * @returns automatically synchronized promise through #recorder
6112
5855
  */
6113
- scrollPageToTop(): Promise<void>;
5856
+ scrollPageToTop(): Promise<any>;
6114
5857
  /**
6115
5858
  * Scroll page to the bottom.
6116
5859
  *
6117
5860
  * ```js
6118
5861
  * I.scrollPageToBottom();
6119
5862
  * ```
6120
- * @returns automatically synchronized promise through #recorder
6121
5863
  */
6122
- scrollPageToBottom(): Promise<void>;
5864
+ scrollPageToBottom(): Promise<any>;
6123
5865
  /**
6124
5866
  * Retrieves a page scroll position and returns it to test.
6125
5867
  * Resumes test execution, so **should be used inside an async function with `await`** operator.
@@ -6164,9 +5906,8 @@ declare namespace CodeceptJS {
6164
5906
  * ]);
6165
5907
  * ```
6166
5908
  * @param cookie - a cookie object or array of cookie objects.
6167
- * @returns automatically synchronized promise through #recorder
6168
5909
  */
6169
- setCookie(cookie: Cookie | Cookie[]): Promise<void>;
5910
+ setCookie(cookie: Cookie | Cookie[]): Promise<any>;
6170
5911
  }
6171
5912
  /**
6172
5913
  * Uses [Google Chrome's Puppeteer](https://github.com/GoogleChrome/puppeteer) library to run tests inside headless Chrome.
@@ -6359,9 +6100,8 @@ declare namespace CodeceptJS {
6359
6100
  * I.seeInPopup('Popup text');
6360
6101
  * ```
6361
6102
  * @param text - value to check.
6362
- * @returns automatically synchronized promise through #recorder
6363
6103
  */
6364
- seeInPopup(text: string): Promise<void>;
6104
+ seeInPopup(text: string): Promise<any>;
6365
6105
  /**
6366
6106
  * Set current page
6367
6107
  * @param page - page to set
@@ -6393,22 +6133,15 @@ declare namespace CodeceptJS {
6393
6133
  * I.amOnPage('/login'); // opens a login page
6394
6134
  * ```
6395
6135
  * @param url - url path or global url.
6396
- * @returns automatically synchronized promise through #recorder
6397
6136
  */
6398
- amOnPage(url: string): Promise<void>;
6137
+ amOnPage(url: string): Promise<any>;
6399
6138
  /**
6400
6139
  * Resize the current window to provided width and height.
6401
6140
  * First parameter can be set to `maximize`.
6402
6141
  * @param width - width in pixels or `maximize`.
6403
6142
  * @param height - height in pixels.
6404
- * @returns automatically synchronized promise through #recorder
6405
- *
6406
- *
6407
- * Unlike other drivers Puppeteer changes the size of a viewport, not the window!
6408
- * Puppeteer does not control the window of a browser so it can't adjust its real size.
6409
- * It also can't maximize a window.
6410
6143
  */
6411
- resizeWindow(width: number, height: number): Promise<void>;
6144
+ resizeWindow(width: number, height: number): Promise<any>;
6412
6145
  /**
6413
6146
  * Set headers for all next requests
6414
6147
  *
@@ -6431,11 +6164,8 @@ declare namespace CodeceptJS {
6431
6164
  * @param locator - located by CSS|XPath|strict locator.
6432
6165
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
6433
6166
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
6434
- * @returns automatically synchronized promise through #recorder
6435
- *
6436
- * {{ react }}
6437
6167
  */
6438
- moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
6168
+ moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
6439
6169
  /**
6440
6170
  * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
6441
6171
  *
@@ -6448,9 +6178,8 @@ declare namespace CodeceptJS {
6448
6178
  * ```
6449
6179
  * @param locator - field located by label|name|CSS|XPath|strict locator.
6450
6180
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
6451
- * @returns automatically synchronized promise through #recorder
6452
6181
  */
6453
- focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
6182
+ focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
6454
6183
  /**
6455
6184
  * Remove focus from a text input, button, etc.
6456
6185
  * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
@@ -6468,9 +6197,8 @@ declare namespace CodeceptJS {
6468
6197
  * ```
6469
6198
  * @param locator - field located by label|name|CSS|XPath|strict locator.
6470
6199
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
6471
- * @returns automatically synchronized promise through #recorder
6472
6200
  */
6473
- blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
6201
+ blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
6474
6202
  /**
6475
6203
  * Drag an item to a destination element.
6476
6204
  *
@@ -6479,36 +6207,32 @@ declare namespace CodeceptJS {
6479
6207
  * ```
6480
6208
  * @param srcElement - located by CSS|XPath|strict locator.
6481
6209
  * @param destElement - located by CSS|XPath|strict locator.
6482
- * @returns automatically synchronized promise through #recorder
6483
6210
  */
6484
- dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): Promise<void>;
6211
+ dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): Promise<any>;
6485
6212
  /**
6486
6213
  * Reload the current page.
6487
6214
  *
6488
6215
  * ```js
6489
6216
  * I.refreshPage();
6490
6217
  * ```
6491
- * @returns automatically synchronized promise through #recorder
6492
6218
  */
6493
- refreshPage(): Promise<void>;
6219
+ refreshPage(): Promise<any>;
6494
6220
  /**
6495
6221
  * Scroll page to the top.
6496
6222
  *
6497
6223
  * ```js
6498
6224
  * I.scrollPageToTop();
6499
6225
  * ```
6500
- * @returns automatically synchronized promise through #recorder
6501
6226
  */
6502
- scrollPageToTop(): Promise<void>;
6227
+ scrollPageToTop(): Promise<any>;
6503
6228
  /**
6504
6229
  * Scroll page to the bottom.
6505
6230
  *
6506
6231
  * ```js
6507
6232
  * I.scrollPageToBottom();
6508
6233
  * ```
6509
- * @returns automatically synchronized promise through #recorder
6510
6234
  */
6511
- scrollPageToBottom(): Promise<void>;
6235
+ scrollPageToBottom(): Promise<any>;
6512
6236
  /**
6513
6237
  * Scrolls to element matched by locator.
6514
6238
  * Extra shift can be set with offsetX and offsetY options.
@@ -6520,9 +6244,8 @@ declare namespace CodeceptJS {
6520
6244
  * @param locator - located by CSS|XPath|strict locator.
6521
6245
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
6522
6246
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
6523
- * @returns automatically synchronized promise through #recorder
6524
6247
  */
6525
- scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
6248
+ scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
6526
6249
  /**
6527
6250
  * Checks that title contains text.
6528
6251
  *
@@ -6530,9 +6253,8 @@ declare namespace CodeceptJS {
6530
6253
  * I.seeInTitle('Home Page');
6531
6254
  * ```
6532
6255
  * @param text - text value to check.
6533
- * @returns automatically synchronized promise through #recorder
6534
6256
  */
6535
- seeInTitle(text: string): Promise<void>;
6257
+ seeInTitle(text: string): Promise<any>;
6536
6258
  /**
6537
6259
  * Retrieves a page scroll position and returns it to test.
6538
6260
  * Resumes test execution, so **should be used inside an async function with `await`** operator.
@@ -6550,9 +6272,8 @@ declare namespace CodeceptJS {
6550
6272
  * I.seeTitleEquals('Test title.');
6551
6273
  * ```
6552
6274
  * @param text - value to check.
6553
- * @returns automatically synchronized promise through #recorder
6554
6275
  */
6555
- seeTitleEquals(text: string): Promise<void>;
6276
+ seeTitleEquals(text: string): Promise<any>;
6556
6277
  /**
6557
6278
  * Checks that title does not contain text.
6558
6279
  *
@@ -6560,9 +6281,8 @@ declare namespace CodeceptJS {
6560
6281
  * I.dontSeeInTitle('Error');
6561
6282
  * ```
6562
6283
  * @param text - value to check.
6563
- * @returns automatically synchronized promise through #recorder
6564
6284
  */
6565
- dontSeeInTitle(text: string): Promise<void>;
6285
+ dontSeeInTitle(text: string): Promise<any>;
6566
6286
  /**
6567
6287
  * Retrieves a page title and returns it to test.
6568
6288
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -6669,11 +6389,8 @@ declare namespace CodeceptJS {
6669
6389
  * I.seeElement('#modal');
6670
6390
  * ```
6671
6391
  * @param locator - located by CSS|XPath|strict locator.
6672
- * @returns automatically synchronized promise through #recorder
6673
- *
6674
- * {{ react }}
6675
6392
  */
6676
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
6393
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
6677
6394
  /**
6678
6395
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
6679
6396
  *
@@ -6681,11 +6398,8 @@ declare namespace CodeceptJS {
6681
6398
  * I.dontSeeElement('.modal'); // modal is not shown
6682
6399
  * ```
6683
6400
  * @param locator - located by CSS|XPath|Strict locator.
6684
- * @returns automatically synchronized promise through #recorder
6685
- *
6686
- * {{ react }}
6687
6401
  */
6688
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
6402
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
6689
6403
  /**
6690
6404
  * Checks that a given Element is present in the DOM
6691
6405
  * Element is located by CSS or XPath.
@@ -6694,9 +6408,8 @@ declare namespace CodeceptJS {
6694
6408
  * I.seeElementInDOM('#modal');
6695
6409
  * ```
6696
6410
  * @param locator - element located by CSS|XPath|strict locator.
6697
- * @returns automatically synchronized promise through #recorder
6698
6411
  */
6699
- seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
6412
+ seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
6700
6413
  /**
6701
6414
  * Opposite to `seeElementInDOM`. Checks that element is not on page.
6702
6415
  *
@@ -6704,9 +6417,8 @@ declare namespace CodeceptJS {
6704
6417
  * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
6705
6418
  * ```
6706
6419
  * @param locator - located by CSS|XPath|Strict locator.
6707
- * @returns automatically synchronized promise through #recorder
6708
6420
  */
6709
- dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
6421
+ dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
6710
6422
  /**
6711
6423
  * Perform a click on a link or a button, given by a locator.
6712
6424
  * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -6731,12 +6443,8 @@ declare namespace CodeceptJS {
6731
6443
  * ```
6732
6444
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
6733
6445
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
6734
- * @returns automatically synchronized promise through #recorder
6735
- *
6736
- *
6737
- * {{ react }}
6738
6446
  */
6739
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<void>;
6447
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<any>;
6740
6448
  /**
6741
6449
  * Perform an emulated click on a link or a button, given by a locator.
6742
6450
  * Unlike normal click instead of sending native event, emulates a click with JavaScript.
@@ -6764,12 +6472,8 @@ declare namespace CodeceptJS {
6764
6472
  * ```
6765
6473
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
6766
6474
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
6767
- * @returns automatically synchronized promise through #recorder
6768
- *
6769
- *
6770
- * {{ react }}
6771
6475
  */
6772
- forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
6476
+ forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
6773
6477
  /**
6774
6478
  * Performs a click on a link and waits for navigation before moving on.
6775
6479
  *
@@ -6778,12 +6482,8 @@ declare namespace CodeceptJS {
6778
6482
  * ```
6779
6483
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator
6780
6484
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator
6781
- * @returns automatically synchronized promise through #recorder
6782
- *
6783
- *
6784
- * {{ react }}
6785
6485
  */
6786
- clickLink(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
6486
+ clickLink(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
6787
6487
  /**
6788
6488
  * Sets a directory to where save files. Allows to test file downloads.
6789
6489
  * Should be used with [FileSystem helper](https://codecept.io/helpers/FileSystem) to check that file were downloaded correctly.
@@ -6819,12 +6519,8 @@ declare namespace CodeceptJS {
6819
6519
  * ```
6820
6520
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
6821
6521
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
6822
- * @returns automatically synchronized promise through #recorder
6823
- *
6824
- *
6825
- * {{ react }}
6826
6522
  */
6827
- doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
6523
+ doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
6828
6524
  /**
6829
6525
  * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
6830
6526
  *
@@ -6838,12 +6534,8 @@ declare namespace CodeceptJS {
6838
6534
  * ```
6839
6535
  * @param locator - clickable element located by CSS|XPath|strict locator.
6840
6536
  * @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
6841
- * @returns automatically synchronized promise through #recorder
6842
- *
6843
- *
6844
- * {{ react }}
6845
6537
  */
6846
- rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
6538
+ rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
6847
6539
  /**
6848
6540
  * Selects a checkbox or radio button.
6849
6541
  * Element is located by label or name or CSS or XPath.
@@ -6857,9 +6549,8 @@ declare namespace CodeceptJS {
6857
6549
  * ```
6858
6550
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
6859
6551
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
6860
- * @returns automatically synchronized promise through #recorder
6861
6552
  */
6862
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
6553
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
6863
6554
  /**
6864
6555
  * Unselects a checkbox or radio button.
6865
6556
  * Element is located by label or name or CSS or XPath.
@@ -6873,9 +6564,8 @@ declare namespace CodeceptJS {
6873
6564
  * ```
6874
6565
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
6875
6566
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
6876
- * @returns automatically synchronized promise through #recorder
6877
6567
  */
6878
- uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
6568
+ uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
6879
6569
  /**
6880
6570
  * Verifies that the specified checkbox is checked.
6881
6571
  *
@@ -6885,9 +6575,8 @@ declare namespace CodeceptJS {
6885
6575
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
6886
6576
  * ```
6887
6577
  * @param field - located by label|name|CSS|XPath|strict locator.
6888
- * @returns automatically synchronized promise through #recorder
6889
6578
  */
6890
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
6579
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
6891
6580
  /**
6892
6581
  * Verifies that the specified checkbox is not checked.
6893
6582
  *
@@ -6897,9 +6586,8 @@ declare namespace CodeceptJS {
6897
6586
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
6898
6587
  * ```
6899
6588
  * @param field - located by label|name|CSS|XPath|strict locator.
6900
- * @returns automatically synchronized promise through #recorder
6901
6589
  */
6902
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
6590
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
6903
6591
  /**
6904
6592
  * Presses a key in the browser and leaves it in a down state.
6905
6593
  *
@@ -6911,9 +6599,8 @@ declare namespace CodeceptJS {
6911
6599
  * I.pressKeyUp('Control');
6912
6600
  * ```
6913
6601
  * @param key - name of key to press down.
6914
- * @returns automatically synchronized promise through #recorder
6915
6602
  */
6916
- pressKeyDown(key: string): Promise<void>;
6603
+ pressKeyDown(key: string): Promise<any>;
6917
6604
  /**
6918
6605
  * Releases a key in the browser which was previously set to a down state.
6919
6606
  *
@@ -6925,9 +6612,8 @@ declare namespace CodeceptJS {
6925
6612
  * I.pressKeyUp('Control');
6926
6613
  * ```
6927
6614
  * @param key - name of key to release.
6928
- * @returns automatically synchronized promise through #recorder
6929
6615
  */
6930
- pressKeyUp(key: string): Promise<void>;
6616
+ pressKeyUp(key: string): Promise<any>;
6931
6617
  /**
6932
6618
  * Presses a key in the browser (on a focused element).
6933
6619
  *
@@ -6987,12 +6673,8 @@ declare namespace CodeceptJS {
6987
6673
  * - `'Space'`
6988
6674
  * - `'Tab'`
6989
6675
  * @param key - key or array of keys to press.
6990
- * @returns automatically synchronized promise through #recorder
6991
- *
6992
- *
6993
- * _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
6994
6676
  */
6995
- pressKey(key: string | string[]): Promise<void>;
6677
+ pressKey(key: string | string[]): Promise<any>;
6996
6678
  /**
6997
6679
  * Types out the given text into an active field.
6998
6680
  * To slow down typing use a second parameter, to set interval between key presses.
@@ -7013,9 +6695,8 @@ declare namespace CodeceptJS {
7013
6695
  * ```
7014
6696
  * @param key - or array of keys to type.
7015
6697
  * @param [delay = null] - (optional) delay in ms between key presses
7016
- * @returns automatically synchronized promise through #recorder
7017
6698
  */
7018
- type(key: string | string[], delay?: number): Promise<void>;
6699
+ type(key: string | string[], delay?: number): Promise<any>;
7019
6700
  /**
7020
6701
  * Fills a text field or textarea, after clearing its value, with the given string.
7021
6702
  * Field is located by name, label, CSS, or XPath.
@@ -7032,11 +6713,8 @@ declare namespace CodeceptJS {
7032
6713
  * ```
7033
6714
  * @param field - located by label|name|CSS|XPath|strict locator.
7034
6715
  * @param value - text value to fill.
7035
- * @returns automatically synchronized promise through #recorder
7036
- *
7037
- * {{ react }}
7038
6716
  */
7039
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
6717
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
7040
6718
  /**
7041
6719
  * Clears a `<textarea>` or text `<input>` element's value.
7042
6720
  *
@@ -7046,9 +6724,8 @@ declare namespace CodeceptJS {
7046
6724
  * I.clearField('#email');
7047
6725
  * ```
7048
6726
  * @param editable - field located by label|name|CSS|XPath|strict locator.
7049
- * @returns automatically synchronized promise through #recorder.
7050
6727
  */
7051
- clearField(editable: LocatorOrString): Promise<void>;
6728
+ clearField(editable: LocatorOrString): Promise<any>;
7052
6729
  /**
7053
6730
  * Appends text to a input field or textarea.
7054
6731
  * Field is located by name, label, CSS or XPath
@@ -7060,12 +6737,8 @@ declare namespace CodeceptJS {
7060
6737
  * ```
7061
6738
  * @param field - located by label|name|CSS|XPath|strict locator
7062
6739
  * @param value - text value to append.
7063
- * @returns automatically synchronized promise through #recorder
7064
- *
7065
- *
7066
- * {{ react }}
7067
6740
  */
7068
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
6741
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
7069
6742
  /**
7070
6743
  * Checks that the given input field or textarea equals to given value.
7071
6744
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -7078,9 +6751,8 @@ declare namespace CodeceptJS {
7078
6751
  * ```
7079
6752
  * @param field - located by label|name|CSS|XPath|strict locator.
7080
6753
  * @param value - value to check.
7081
- * @returns automatically synchronized promise through #recorder
7082
6754
  */
7083
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
6755
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
7084
6756
  /**
7085
6757
  * Checks that value of input field or textarea doesn't equal to given value
7086
6758
  * Opposite to `seeInField`.
@@ -7091,9 +6763,8 @@ declare namespace CodeceptJS {
7091
6763
  * ```
7092
6764
  * @param field - located by label|name|CSS|XPath|strict locator.
7093
6765
  * @param value - value to check.
7094
- * @returns automatically synchronized promise through #recorder
7095
6766
  */
7096
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
6767
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
7097
6768
  /**
7098
6769
  * Attaches a file to element located by label, name, CSS or XPath
7099
6770
  * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -7105,12 +6776,8 @@ declare namespace CodeceptJS {
7105
6776
  * ```
7106
6777
  * @param locator - field located by label|name|CSS|XPath|strict locator.
7107
6778
  * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
7108
- * @returns automatically synchronized promise through #recorder
7109
- *
7110
- *
7111
- * > ⚠ There is an [issue with file upload in Puppeteer 2.1.0 & 2.1.1](https://github.com/puppeteer/puppeteer/issues/5420), downgrade to 2.0.0 if you face it.
7112
6779
  */
7113
- attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<void>;
6780
+ attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
7114
6781
  /**
7115
6782
  * Selects an option in a drop-down select.
7116
6783
  * Field is searched by label | name | CSS | XPath.
@@ -7132,9 +6799,8 @@ declare namespace CodeceptJS {
7132
6799
  * ```
7133
6800
  * @param select - field located by label|name|CSS|XPath|strict locator.
7134
6801
  * @param option - visible text or value of option.
7135
- * @returns automatically synchronized promise through #recorder
7136
6802
  */
7137
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
6803
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
7138
6804
  /**
7139
6805
  * Grab number of visible elements by locator.
7140
6806
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -7154,15 +6820,13 @@ declare namespace CodeceptJS {
7154
6820
  * I.seeInCurrentUrl('/register'); // we are on registration page
7155
6821
  * ```
7156
6822
  * @param url - a fragment to check
7157
- * @returns automatically synchronized promise through #recorder
7158
6823
  */
7159
- seeInCurrentUrl(url: string): Promise<void>;
6824
+ seeInCurrentUrl(url: string): Promise<any>;
7160
6825
  /**
7161
6826
  * Checks that current url does not contain a provided fragment.
7162
6827
  * @param url - value to check.
7163
- * @returns automatically synchronized promise through #recorder
7164
6828
  */
7165
- dontSeeInCurrentUrl(url: string): Promise<void>;
6829
+ dontSeeInCurrentUrl(url: string): Promise<any>;
7166
6830
  /**
7167
6831
  * Checks that current url is equal to provided one.
7168
6832
  * If a relative url provided, a configured url will be prepended to it.
@@ -7173,9 +6837,8 @@ declare namespace CodeceptJS {
7173
6837
  * I.seeCurrentUrlEquals('http://my.site.com/register');
7174
6838
  * ```
7175
6839
  * @param url - value to check.
7176
- * @returns automatically synchronized promise through #recorder
7177
6840
  */
7178
- seeCurrentUrlEquals(url: string): Promise<void>;
6841
+ seeCurrentUrlEquals(url: string): Promise<any>;
7179
6842
  /**
7180
6843
  * Checks that current url is not equal to provided one.
7181
6844
  * If a relative url provided, a configured url will be prepended to it.
@@ -7185,9 +6848,8 @@ declare namespace CodeceptJS {
7185
6848
  * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
7186
6849
  * ```
7187
6850
  * @param url - value to check.
7188
- * @returns automatically synchronized promise through #recorder
7189
6851
  */
7190
- dontSeeCurrentUrlEquals(url: string): Promise<void>;
6852
+ dontSeeCurrentUrlEquals(url: string): Promise<any>;
7191
6853
  /**
7192
6854
  * Checks that a page contains a visible text.
7193
6855
  * Use context parameter to narrow down the search.
@@ -7199,12 +6861,8 @@ declare namespace CodeceptJS {
7199
6861
  * ```
7200
6862
  * @param text - expected on page.
7201
6863
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
7202
- * @returns automatically synchronized promise through #recorder
7203
- *
7204
- *
7205
- * {{ react }}
7206
6864
  */
7207
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
6865
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
7208
6866
  /**
7209
6867
  * Checks that text is equal to provided one.
7210
6868
  *
@@ -7213,9 +6871,8 @@ declare namespace CodeceptJS {
7213
6871
  * ```
7214
6872
  * @param text - element value to check.
7215
6873
  * @param [context = null] - element located by CSS|XPath|strict locator.
7216
- * @returns automatically synchronized promise through #recorder
7217
6874
  */
7218
- seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
6875
+ seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
7219
6876
  /**
7220
6877
  * Opposite to `see`. Checks that a text is not present on a page.
7221
6878
  * Use context parameter to narrow down the search.
@@ -7226,12 +6883,8 @@ declare namespace CodeceptJS {
7226
6883
  * ```
7227
6884
  * @param text - which is not present.
7228
6885
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
7229
- * @returns automatically synchronized promise through #recorder
7230
- *
7231
- *
7232
- * {{ react }}
7233
6886
  */
7234
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
6887
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
7235
6888
  /**
7236
6889
  * Retrieves page source and returns it to test.
7237
6890
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -7269,9 +6922,8 @@ declare namespace CodeceptJS {
7269
6922
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
7270
6923
  * ```
7271
6924
  * @param text - value to check.
7272
- * @returns automatically synchronized promise through #recorder
7273
6925
  */
7274
- seeInSource(text: string): Promise<void>;
6926
+ seeInSource(text: string): Promise<any>;
7275
6927
  /**
7276
6928
  * Checks that the current page does not contains the given string in its raw source code.
7277
6929
  *
@@ -7279,9 +6931,8 @@ declare namespace CodeceptJS {
7279
6931
  * I.dontSeeInSource('<!--'); // no comments in source
7280
6932
  * ```
7281
6933
  * @param value - to check.
7282
- * @returns automatically synchronized promise through #recorder
7283
6934
  */
7284
- dontSeeInSource(value: string): Promise<void>;
6935
+ dontSeeInSource(value: string): Promise<any>;
7285
6936
  /**
7286
6937
  * Asserts that an element appears a given number of times in the DOM.
7287
6938
  * Element is located by label or name or CSS or XPath.
@@ -7292,12 +6943,8 @@ declare namespace CodeceptJS {
7292
6943
  * ```
7293
6944
  * @param locator - element located by CSS|XPath|strict locator.
7294
6945
  * @param num - number of elements.
7295
- * @returns automatically synchronized promise through #recorder
7296
- *
7297
- *
7298
- * {{ react }}
7299
6946
  */
7300
- seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
6947
+ seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
7301
6948
  /**
7302
6949
  * Asserts that an element is visible a given number of times.
7303
6950
  * Element is located by CSS or XPath.
@@ -7307,12 +6954,8 @@ declare namespace CodeceptJS {
7307
6954
  * ```
7308
6955
  * @param locator - element located by CSS|XPath|strict locator.
7309
6956
  * @param num - number of elements.
7310
- * @returns automatically synchronized promise through #recorder
7311
- *
7312
- *
7313
- * {{ react }}
7314
6957
  */
7315
- seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
6958
+ seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
7316
6959
  /**
7317
6960
  * Sets cookie(s).
7318
6961
  *
@@ -7328,9 +6971,8 @@ declare namespace CodeceptJS {
7328
6971
  * ]);
7329
6972
  * ```
7330
6973
  * @param cookie - a cookie object or array of cookie objects.
7331
- * @returns automatically synchronized promise through #recorder
7332
6974
  */
7333
- setCookie(cookie: Cookie | Cookie[]): Promise<void>;
6975
+ setCookie(cookie: Cookie | Cookie[]): Promise<any>;
7334
6976
  /**
7335
6977
  * Checks that cookie with given name exists.
7336
6978
  *
@@ -7338,9 +6980,8 @@ declare namespace CodeceptJS {
7338
6980
  * I.seeCookie('Auth');
7339
6981
  * ```
7340
6982
  * @param name - cookie name.
7341
- * @returns automatically synchronized promise through #recorder
7342
6983
  */
7343
- seeCookie(name: string): Promise<void>;
6984
+ seeCookie(name: string): Promise<any>;
7344
6985
  /**
7345
6986
  * Checks that cookie with given name does not exist.
7346
6987
  *
@@ -7348,9 +6989,8 @@ declare namespace CodeceptJS {
7348
6989
  * I.dontSeeCookie('auth'); // no auth cookie
7349
6990
  * ```
7350
6991
  * @param name - cookie name.
7351
- * @returns automatically synchronized promise through #recorder
7352
6992
  */
7353
- dontSeeCookie(name: string): Promise<void>;
6993
+ dontSeeCookie(name: string): Promise<any>;
7354
6994
  /**
7355
6995
  * Gets a cookie object by name.
7356
6996
  * If none provided gets all cookies.
@@ -7369,12 +7009,11 @@ declare namespace CodeceptJS {
7369
7009
  *
7370
7010
  * ```js
7371
7011
  * I.clearCookie();
7372
- * I.clearCookie('test');
7012
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
7373
7013
  * ```
7374
7014
  * @param [cookie = null] - (optional, `null` by default) cookie name
7375
- * @returns automatically synchronized promise through #recorder
7376
7015
  */
7377
- clearCookie(cookie?: string): Promise<void>;
7016
+ clearCookie(cookie?: string): Promise<any>;
7378
7017
  /**
7379
7018
  * Executes sync script on a page.
7380
7019
  * Pass arguments to function as additional parameters.
@@ -7545,11 +7184,8 @@ declare namespace CodeceptJS {
7545
7184
  * ```
7546
7185
  * @param locator - located by CSS|XPath|strict locator.
7547
7186
  * @param cssProperties - object with CSS properties and their values to check.
7548
- * @returns automatically synchronized promise through #recorder
7549
- *
7550
- * {{ react }}
7551
7187
  */
7552
- seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<void>;
7188
+ seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<any>;
7553
7189
  /**
7554
7190
  * Checks that all elements with given locator have given attributes.
7555
7191
  *
@@ -7558,11 +7194,8 @@ declare namespace CodeceptJS {
7558
7194
  * ```
7559
7195
  * @param locator - located by CSS|XPath|strict locator.
7560
7196
  * @param attributes - attributes and their values to check.
7561
- * @returns automatically synchronized promise through #recorder
7562
- *
7563
- * {{ react }}
7564
7197
  */
7565
- seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<void>;
7198
+ seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<any>;
7566
7199
  /**
7567
7200
  * Drag the scrubber of a slider to a given position
7568
7201
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -7573,11 +7206,8 @@ declare namespace CodeceptJS {
7573
7206
  * ```
7574
7207
  * @param locator - located by label|name|CSS|XPath|strict locator.
7575
7208
  * @param offsetX - position to drag.
7576
- * @returns automatically synchronized promise through #recorder
7577
- *
7578
- * {{ react }}
7579
7209
  */
7580
- dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): Promise<void>;
7210
+ dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): Promise<any>;
7581
7211
  /**
7582
7212
  * Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
7583
7213
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -7616,9 +7246,8 @@ declare namespace CodeceptJS {
7616
7246
  * ```
7617
7247
  * @param locator - element located by CSS|XPath|strict locator.
7618
7248
  * @param fileName - file name to save.
7619
- * @returns automatically synchronized promise through #recorder
7620
7249
  */
7621
- saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<void>;
7250
+ saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<any>;
7622
7251
  /**
7623
7252
  * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
7624
7253
  * Filename is relative to output folder.
@@ -7630,9 +7259,8 @@ declare namespace CodeceptJS {
7630
7259
  * ```
7631
7260
  * @param fileName - file name to save.
7632
7261
  * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
7633
- * @returns automatically synchronized promise through #recorder
7634
7262
  */
7635
- saveScreenshot(fileName: string, fullPage?: boolean): Promise<void>;
7263
+ saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
7636
7264
  /**
7637
7265
  * Pauses execution for a number of seconds.
7638
7266
  *
@@ -7640,17 +7268,15 @@ declare namespace CodeceptJS {
7640
7268
  * I.wait(2); // wait 2 secs
7641
7269
  * ```
7642
7270
  * @param sec - number of second to wait.
7643
- * @returns automatically synchronized promise through #recorder
7644
7271
  */
7645
- wait(sec: number): Promise<void>;
7272
+ wait(sec: number): Promise<any>;
7646
7273
  /**
7647
7274
  * Waits for element to become enabled (by default waits for 1sec).
7648
7275
  * Element can be located by CSS or XPath.
7649
7276
  * @param locator - element located by CSS|XPath|strict locator.
7650
7277
  * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
7651
- * @returns automatically synchronized promise through #recorder
7652
7278
  */
7653
- waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7279
+ waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7654
7280
  /**
7655
7281
  * Waits for the specified value to be in value attribute.
7656
7282
  *
@@ -7660,9 +7286,8 @@ declare namespace CodeceptJS {
7660
7286
  * @param field - input field.
7661
7287
  * @param value - expected value.
7662
7288
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7663
- * @returns automatically synchronized promise through #recorder
7664
7289
  */
7665
- waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<void>;
7290
+ waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<any>;
7666
7291
  /**
7667
7292
  * Waits for a specified number of elements on the page.
7668
7293
  *
@@ -7672,11 +7297,8 @@ declare namespace CodeceptJS {
7672
7297
  * @param locator - element located by CSS|XPath|strict locator.
7673
7298
  * @param num - number of elements.
7674
7299
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7675
- * @returns automatically synchronized promise through #recorder
7676
- *
7677
- * {{ react }}
7678
7300
  */
7679
- waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<void>;
7301
+ waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<any>;
7680
7302
  /**
7681
7303
  * Waits for element to be clickable (by default waits for 1sec).
7682
7304
  * Element can be located by CSS or XPath.
@@ -7687,9 +7309,8 @@ declare namespace CodeceptJS {
7687
7309
  * ```
7688
7310
  * @param locator - element located by CSS|XPath|strict locator.
7689
7311
  * @param [sec] - (optional, `1` by default) time in seconds to wait
7690
- * @returns automatically synchronized promise through #recorder
7691
7312
  */
7692
- waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7313
+ waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7693
7314
  /**
7694
7315
  * Waits for element to be present on page (by default waits for 1sec).
7695
7316
  * Element can be located by CSS or XPath.
@@ -7700,11 +7321,8 @@ declare namespace CodeceptJS {
7700
7321
  * ```
7701
7322
  * @param locator - element located by CSS|XPath|strict locator.
7702
7323
  * @param [sec] - (optional, `1` by default) time in seconds to wait
7703
- * @returns automatically synchronized promise through #recorder
7704
- *
7705
- * {{ react }}
7706
7324
  */
7707
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7325
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7708
7326
  /**
7709
7327
  * Waits for an element to become visible on a page (by default waits for 1sec).
7710
7328
  * Element can be located by CSS or XPath.
@@ -7714,12 +7332,8 @@ declare namespace CodeceptJS {
7714
7332
  * ```
7715
7333
  * @param locator - element located by CSS|XPath|strict locator.
7716
7334
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7717
- * @returns automatically synchronized promise through #recorder
7718
- *
7719
- *
7720
- * This method accepts [React selectors](https://codecept.io/react).
7721
7335
  */
7722
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7336
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7723
7337
  /**
7724
7338
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
7725
7339
  * Element can be located by CSS or XPath.
@@ -7729,9 +7343,8 @@ declare namespace CodeceptJS {
7729
7343
  * ```
7730
7344
  * @param locator - element located by CSS|XPath|strict locator.
7731
7345
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7732
- * @returns automatically synchronized promise through #recorder
7733
7346
  */
7734
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7347
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7735
7348
  /**
7736
7349
  * Waits for an element to hide (by default waits for 1sec).
7737
7350
  * Element can be located by CSS or XPath.
@@ -7741,9 +7354,8 @@ declare namespace CodeceptJS {
7741
7354
  * ```
7742
7355
  * @param locator - element located by CSS|XPath|strict locator.
7743
7356
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7744
- * @returns automatically synchronized promise through #recorder
7745
7357
  */
7746
- waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7358
+ waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7747
7359
  /**
7748
7360
  * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
7749
7361
  *
@@ -7752,9 +7364,8 @@ declare namespace CodeceptJS {
7752
7364
  * ```
7753
7365
  * @param urlPart - value to check.
7754
7366
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7755
- * @returns automatically synchronized promise through #recorder
7756
7367
  */
7757
- waitInUrl(urlPart: string, sec?: number): Promise<void>;
7368
+ waitInUrl(urlPart: string, sec?: number): Promise<any>;
7758
7369
  /**
7759
7370
  * Waits for the entire URL to match the expected
7760
7371
  *
@@ -7764,9 +7375,8 @@ declare namespace CodeceptJS {
7764
7375
  * ```
7765
7376
  * @param urlPart - value to check.
7766
7377
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7767
- * @returns automatically synchronized promise through #recorder
7768
7378
  */
7769
- waitUrlEquals(urlPart: string, sec?: number): Promise<void>;
7379
+ waitUrlEquals(urlPart: string, sec?: number): Promise<any>;
7770
7380
  /**
7771
7381
  * Waits for a text to appear (by default waits for 1sec).
7772
7382
  * Element can be located by CSS or XPath.
@@ -7779,9 +7389,8 @@ declare namespace CodeceptJS {
7779
7389
  * @param text - to wait for.
7780
7390
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7781
7391
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
7782
- * @returns automatically synchronized promise through #recorder
7783
7392
  */
7784
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
7393
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
7785
7394
  /**
7786
7395
  * Waits for a network request.
7787
7396
  *
@@ -7810,9 +7419,8 @@ declare namespace CodeceptJS {
7810
7419
  * I.switchTo(); // switch back to main page
7811
7420
  * ```
7812
7421
  * @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
7813
- * @returns automatically synchronized promise through #recorder
7814
7422
  */
7815
- switchTo(locator?: CodeceptJS.LocatorOrString): Promise<void>;
7423
+ switchTo(locator?: CodeceptJS.LocatorOrString): Promise<any>;
7816
7424
  /**
7817
7425
  * Waits for a function to return true (waits for 1 sec by default).
7818
7426
  * Running in browser context.
@@ -7829,9 +7437,8 @@ declare namespace CodeceptJS {
7829
7437
  * @param fn - to be executed in browser context.
7830
7438
  * @param [argsOrSec = null] - (optional, `1` by default) arguments for function or seconds.
7831
7439
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
7832
- * @returns automatically synchronized promise through #recorder
7833
7440
  */
7834
- waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<void>;
7441
+ waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
7835
7442
  /**
7836
7443
  * Waits for navigation to finish. By default takes configured `waitForNavigation` option.
7837
7444
  *
@@ -7847,9 +7454,8 @@ declare namespace CodeceptJS {
7847
7454
  * ```
7848
7455
  * @param locator - element located by CSS|XPath|strict locator.
7849
7456
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
7850
- * @returns automatically synchronized promise through #recorder
7851
7457
  */
7852
- waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7458
+ waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
7853
7459
  /**
7854
7460
  * Grab the data from performance timing using Navigation Timing API.
7855
7461
  * The returned data will contain following things in ms:
@@ -7870,9 +7476,8 @@ declare namespace CodeceptJS {
7870
7476
  * loadEventEnd: 241
7871
7477
  * }
7872
7478
  * ```
7873
- * @returns automatically synchronized promise through #recorder
7874
7479
  */
7875
- grabDataFromPerformanceTiming(): Promise<void>;
7480
+ grabDataFromPerformanceTiming(): Promise<any>;
7876
7481
  /**
7877
7482
  * Grab the width, height, location of given locator.
7878
7483
  * Provide `width` or `height`as second param to get your desired prop.
@@ -8140,17 +7745,15 @@ declare namespace CodeceptJS {
8140
7745
  * I.amOnPage('/login'); // opens a login page
8141
7746
  * ```
8142
7747
  * @param url - url path or global url.
8143
- * @returns automatically synchronized promise through #recorder
8144
7748
  */
8145
- amOnPage(url: string): Promise<void>;
7749
+ amOnPage(url: string): Promise<any>;
8146
7750
  /**
8147
7751
  * Resize the current window to provided width and height.
8148
7752
  * First parameter can be set to `maximize`.
8149
7753
  * @param width - width in pixels or `maximize`.
8150
7754
  * @param height - height in pixels.
8151
- * @returns automatically synchronized promise through #recorder
8152
7755
  */
8153
- resizeWindow(width: number, height: number): Promise<void>;
7756
+ resizeWindow(width: number, height: number): Promise<any>;
8154
7757
  /**
8155
7758
  * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
8156
7759
  *
@@ -8163,9 +7766,8 @@ declare namespace CodeceptJS {
8163
7766
  * ```
8164
7767
  * @param locator - field located by label|name|CSS|XPath|strict locator.
8165
7768
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
8166
- * @returns automatically synchronized promise through #recorder
8167
7769
  */
8168
- focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
7770
+ focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
8169
7771
  /**
8170
7772
  * Remove focus from a text input, button, etc.
8171
7773
  * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
@@ -8183,9 +7785,8 @@ declare namespace CodeceptJS {
8183
7785
  * ```
8184
7786
  * @param locator - field located by label|name|CSS|XPath|strict locator.
8185
7787
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
8186
- * @returns automatically synchronized promise through #recorder
8187
7788
  */
8188
- blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
7789
+ blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
8189
7790
  /**
8190
7791
  * Perform a click on a link or a button, given by a locator.
8191
7792
  * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -8210,18 +7811,16 @@ declare namespace CodeceptJS {
8210
7811
  * ```
8211
7812
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
8212
7813
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
8213
- * @returns automatically synchronized promise through #recorder
8214
7814
  */
8215
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<void>;
7815
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<any>;
8216
7816
  /**
8217
7817
  * Reload the current page.
8218
7818
  *
8219
7819
  * ```js
8220
7820
  * I.refreshPage();
8221
7821
  * ```
8222
- * @returns automatically synchronized promise through #recorder
8223
7822
  */
8224
- refreshPage(): Promise<void>;
7823
+ refreshPage(): Promise<any>;
8225
7824
  /**
8226
7825
  * Waits for an element to become visible on a page (by default waits for 1sec).
8227
7826
  * Element can be located by CSS or XPath.
@@ -8231,9 +7830,8 @@ declare namespace CodeceptJS {
8231
7830
  * ```
8232
7831
  * @param locator - element located by CSS|XPath|strict locator.
8233
7832
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
8234
- * @returns automatically synchronized promise through #recorder
8235
7833
  */
8236
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
7834
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
8237
7835
  /**
8238
7836
  * Fills a text field or textarea, after clearing its value, with the given string.
8239
7837
  * Field is located by name, label, CSS, or XPath.
@@ -8250,9 +7848,8 @@ declare namespace CodeceptJS {
8250
7848
  * ```
8251
7849
  * @param field - located by label|name|CSS|XPath|strict locator.
8252
7850
  * @param value - text value to fill.
8253
- * @returns automatically synchronized promise through #recorder
8254
7851
  */
8255
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
7852
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
8256
7853
  /**
8257
7854
  * Clears a `<textarea>` or text `<input>` element's value.
8258
7855
  *
@@ -8262,9 +7859,8 @@ declare namespace CodeceptJS {
8262
7859
  * I.clearField('#email');
8263
7860
  * ```
8264
7861
  * @param editable - field located by label|name|CSS|XPath|strict locator.
8265
- * @returns automatically synchronized promise through #recorder.
8266
7862
  */
8267
- clearField(editable: LocatorOrString): Promise<void>;
7863
+ clearField(editable: LocatorOrString): Promise<any>;
8268
7864
  /**
8269
7865
  * Appends text to a input field or textarea.
8270
7866
  * Field is located by name, label, CSS or XPath
@@ -8276,9 +7872,8 @@ declare namespace CodeceptJS {
8276
7872
  * ```
8277
7873
  * @param field - located by label|name|CSS|XPath|strict locator
8278
7874
  * @param value - text value to append.
8279
- * @returns automatically synchronized promise through #recorder
8280
7875
  */
8281
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
7876
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
8282
7877
  /**
8283
7878
  * Attaches a file to element located by label, name, CSS or XPath
8284
7879
  * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -8290,9 +7885,8 @@ declare namespace CodeceptJS {
8290
7885
  * ```
8291
7886
  * @param locator - field located by label|name|CSS|XPath|strict locator.
8292
7887
  * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
8293
- * @returns automatically synchronized promise through #recorder
8294
7888
  */
8295
- attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<void>;
7889
+ attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
8296
7890
  /**
8297
7891
  * Presses a key on a focused element.
8298
7892
  * Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
@@ -8304,12 +7898,8 @@ declare namespace CodeceptJS {
8304
7898
  * I.pressKey(['Control','a']);
8305
7899
  * ```
8306
7900
  * @param key - key or array of keys to press.
8307
- * @returns automatically synchronized promise through #recorder
8308
- *
8309
- *
8310
- * {{ keys }}
8311
7901
  */
8312
- pressKey(key: string | string[]): Promise<void>;
7902
+ pressKey(key: string | string[]): Promise<any>;
8313
7903
  /**
8314
7904
  * Moves cursor to element matched by locator.
8315
7905
  * Extra shift can be set with offsetX and offsetY options.
@@ -8321,9 +7911,8 @@ declare namespace CodeceptJS {
8321
7911
  * @param locator - located by CSS|XPath|strict locator.
8322
7912
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
8323
7913
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
8324
- * @returns automatically synchronized promise through #recorder
8325
7914
  */
8326
- moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
7915
+ moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
8327
7916
  /**
8328
7917
  * Performs a double-click on an element matched by link|button|label|CSS or XPath.
8329
7918
  * Context can be specified as second parameter to narrow search.
@@ -8336,9 +7925,8 @@ declare namespace CodeceptJS {
8336
7925
  * ```
8337
7926
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
8338
7927
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
8339
- * @returns automatically synchronized promise through #recorder
8340
7928
  */
8341
- doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
7929
+ doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
8342
7930
  /**
8343
7931
  * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
8344
7932
  *
@@ -8352,9 +7940,8 @@ declare namespace CodeceptJS {
8352
7940
  * ```
8353
7941
  * @param locator - clickable element located by CSS|XPath|strict locator.
8354
7942
  * @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
8355
- * @returns automatically synchronized promise through #recorder
8356
7943
  */
8357
- rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
7944
+ rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
8358
7945
  /**
8359
7946
  * Selects a checkbox or radio button.
8360
7947
  * Element is located by label or name or CSS or XPath.
@@ -8368,9 +7955,8 @@ declare namespace CodeceptJS {
8368
7955
  * ```
8369
7956
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
8370
7957
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
8371
- * @returns automatically synchronized promise through #recorder
8372
7958
  */
8373
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
7959
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
8374
7960
  /**
8375
7961
  * Unselects a checkbox or radio button.
8376
7962
  * Element is located by label or name or CSS or XPath.
@@ -8384,9 +7970,8 @@ declare namespace CodeceptJS {
8384
7970
  * ```
8385
7971
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
8386
7972
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
8387
- * @returns automatically synchronized promise through #recorder
8388
7973
  */
8389
- uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
7974
+ uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
8390
7975
  /**
8391
7976
  * Verifies that the specified checkbox is checked.
8392
7977
  *
@@ -8396,9 +7981,8 @@ declare namespace CodeceptJS {
8396
7981
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
8397
7982
  * ```
8398
7983
  * @param field - located by label|name|CSS|XPath|strict locator.
8399
- * @returns automatically synchronized promise through #recorder
8400
7984
  */
8401
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
7985
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
8402
7986
  /**
8403
7987
  * Verifies that the specified checkbox is not checked.
8404
7988
  *
@@ -8408,9 +7992,8 @@ declare namespace CodeceptJS {
8408
7992
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
8409
7993
  * ```
8410
7994
  * @param field - located by label|name|CSS|XPath|strict locator.
8411
- * @returns automatically synchronized promise through #recorder
8412
7995
  */
8413
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
7996
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
8414
7997
  /**
8415
7998
  * Selects an option in a drop-down select.
8416
7999
  * Field is searched by label | name | CSS | XPath.
@@ -8432,9 +8015,8 @@ declare namespace CodeceptJS {
8432
8015
  * ```
8433
8016
  * @param select - field located by label|name|CSS|XPath|strict locator.
8434
8017
  * @param option - visible text or value of option.
8435
- * @returns automatically synchronized promise through #recorder
8436
8018
  */
8437
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
8019
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
8438
8020
  /**
8439
8021
  * Checks that current url contains a provided fragment.
8440
8022
  *
@@ -8442,15 +8024,13 @@ declare namespace CodeceptJS {
8442
8024
  * I.seeInCurrentUrl('/register'); // we are on registration page
8443
8025
  * ```
8444
8026
  * @param url - a fragment to check
8445
- * @returns automatically synchronized promise through #recorder
8446
8027
  */
8447
- seeInCurrentUrl(url: string): Promise<void>;
8028
+ seeInCurrentUrl(url: string): Promise<any>;
8448
8029
  /**
8449
8030
  * Checks that current url does not contain a provided fragment.
8450
8031
  * @param url - value to check.
8451
- * @returns automatically synchronized promise through #recorder
8452
8032
  */
8453
- dontSeeInCurrentUrl(url: string): Promise<void>;
8033
+ dontSeeInCurrentUrl(url: string): Promise<any>;
8454
8034
  /**
8455
8035
  * Checks that current url is equal to provided one.
8456
8036
  * If a relative url provided, a configured url will be prepended to it.
@@ -8461,9 +8041,8 @@ declare namespace CodeceptJS {
8461
8041
  * I.seeCurrentUrlEquals('http://my.site.com/register');
8462
8042
  * ```
8463
8043
  * @param url - value to check.
8464
- * @returns automatically synchronized promise through #recorder
8465
8044
  */
8466
- seeCurrentUrlEquals(url: string): Promise<void>;
8045
+ seeCurrentUrlEquals(url: string): Promise<any>;
8467
8046
  /**
8468
8047
  * Checks that current url is not equal to provided one.
8469
8048
  * If a relative url provided, a configured url will be prepended to it.
@@ -8473,9 +8052,8 @@ declare namespace CodeceptJS {
8473
8052
  * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
8474
8053
  * ```
8475
8054
  * @param url - value to check.
8476
- * @returns automatically synchronized promise through #recorder
8477
8055
  */
8478
- dontSeeCurrentUrlEquals(url: string): Promise<void>;
8056
+ dontSeeCurrentUrlEquals(url: string): Promise<any>;
8479
8057
  /**
8480
8058
  * Checks that a page contains a visible text.
8481
8059
  * Use context parameter to narrow down the search.
@@ -8487,9 +8065,8 @@ declare namespace CodeceptJS {
8487
8065
  * ```
8488
8066
  * @param text - expected on page.
8489
8067
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
8490
- * @returns automatically synchronized promise through #recorder
8491
8068
  */
8492
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
8069
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
8493
8070
  /**
8494
8071
  * Opposite to `see`. Checks that a text is not present on a page.
8495
8072
  * Use context parameter to narrow down the search.
@@ -8500,9 +8077,8 @@ declare namespace CodeceptJS {
8500
8077
  * ```
8501
8078
  * @param text - which is not present.
8502
8079
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
8503
- * @returns automatically synchronized promise through #recorder
8504
8080
  */
8505
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
8081
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
8506
8082
  /**
8507
8083
  * Checks that a given Element is visible
8508
8084
  * Element is located by CSS or XPath.
@@ -8511,9 +8087,8 @@ declare namespace CodeceptJS {
8511
8087
  * I.seeElement('#modal');
8512
8088
  * ```
8513
8089
  * @param locator - located by CSS|XPath|strict locator.
8514
- * @returns automatically synchronized promise through #recorder
8515
8090
  */
8516
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
8091
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
8517
8092
  /**
8518
8093
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
8519
8094
  *
@@ -8521,9 +8096,8 @@ declare namespace CodeceptJS {
8521
8096
  * I.dontSeeElement('.modal'); // modal is not shown
8522
8097
  * ```
8523
8098
  * @param locator - located by CSS|XPath|Strict locator.
8524
- * @returns automatically synchronized promise through #recorder
8525
8099
  */
8526
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
8100
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
8527
8101
  /**
8528
8102
  * Checks that a given Element is present in the DOM
8529
8103
  * Element is located by CSS or XPath.
@@ -8532,9 +8106,8 @@ declare namespace CodeceptJS {
8532
8106
  * I.seeElementInDOM('#modal');
8533
8107
  * ```
8534
8108
  * @param locator - element located by CSS|XPath|strict locator.
8535
- * @returns automatically synchronized promise through #recorder
8536
8109
  */
8537
- seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
8110
+ seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
8538
8111
  /**
8539
8112
  * Opposite to `seeElementInDOM`. Checks that element is not on page.
8540
8113
  *
@@ -8542,9 +8115,8 @@ declare namespace CodeceptJS {
8542
8115
  * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
8543
8116
  * ```
8544
8117
  * @param locator - located by CSS|XPath|Strict locator.
8545
- * @returns automatically synchronized promise through #recorder
8546
8118
  */
8547
- dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
8119
+ dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
8548
8120
  /**
8549
8121
  * Asserts that an element is visible a given number of times.
8550
8122
  * Element is located by CSS or XPath.
@@ -8554,9 +8126,8 @@ declare namespace CodeceptJS {
8554
8126
  * ```
8555
8127
  * @param locator - element located by CSS|XPath|strict locator.
8556
8128
  * @param num - number of elements.
8557
- * @returns automatically synchronized promise through #recorder
8558
8129
  */
8559
- seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
8130
+ seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
8560
8131
  /**
8561
8132
  * Grab number of visible elements by locator.
8562
8133
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -8580,9 +8151,8 @@ declare namespace CodeceptJS {
8580
8151
  * ```
8581
8152
  * @param field - located by label|name|CSS|XPath|strict locator.
8582
8153
  * @param value - value to check.
8583
- * @returns automatically synchronized promise through #recorder
8584
8154
  */
8585
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
8155
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
8586
8156
  /**
8587
8157
  * Checks that value of input field or textarea doesn't equal to given value
8588
8158
  * Opposite to `seeInField`.
@@ -8593,9 +8163,8 @@ declare namespace CodeceptJS {
8593
8163
  * ```
8594
8164
  * @param field - located by label|name|CSS|XPath|strict locator.
8595
8165
  * @param value - value to check.
8596
- * @returns automatically synchronized promise through #recorder
8597
8166
  */
8598
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
8167
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
8599
8168
  /**
8600
8169
  * Checks that text is equal to provided one.
8601
8170
  *
@@ -8611,9 +8180,8 @@ declare namespace CodeceptJS {
8611
8180
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
8612
8181
  * ```
8613
8182
  * @param text - value to check.
8614
- * @returns automatically synchronized promise through #recorder
8615
8183
  */
8616
- seeInSource(text: string): Promise<void>;
8184
+ seeInSource(text: string): Promise<any>;
8617
8185
  /**
8618
8186
  * Checks that the current page does not contains the given string in its raw source code.
8619
8187
  *
@@ -8621,9 +8189,8 @@ declare namespace CodeceptJS {
8621
8189
  * I.dontSeeInSource('<!--'); // no comments in source
8622
8190
  * ```
8623
8191
  * @param value - to check.
8624
- * @returns automatically synchronized promise through #recorder
8625
8192
  */
8626
- dontSeeInSource(value: string): Promise<void>;
8193
+ dontSeeInSource(value: string): Promise<any>;
8627
8194
  /**
8628
8195
  * Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
8629
8196
  * Filename is relative to output folder.
@@ -8633,9 +8200,8 @@ declare namespace CodeceptJS {
8633
8200
  * ```
8634
8201
  * @param locator - element located by CSS|XPath|strict locator.
8635
8202
  * @param fileName - file name to save.
8636
- * @returns automatically synchronized promise through #recorder
8637
8203
  */
8638
- saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<void>;
8204
+ saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<any>;
8639
8205
  /**
8640
8206
  * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
8641
8207
  * Filename is relative to output folder.
@@ -8647,9 +8213,8 @@ declare namespace CodeceptJS {
8647
8213
  * ```
8648
8214
  * @param fileName - file name to save.
8649
8215
  * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
8650
- * @returns automatically synchronized promise through #recorder
8651
8216
  */
8652
- saveScreenshot(fileName: string, fullPage?: boolean): Promise<void>;
8217
+ saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
8653
8218
  /**
8654
8219
  * Pauses execution for a number of seconds.
8655
8220
  *
@@ -8657,9 +8222,8 @@ declare namespace CodeceptJS {
8657
8222
  * I.wait(2); // wait 2 secs
8658
8223
  * ```
8659
8224
  * @param sec - number of second to wait.
8660
- * @returns automatically synchronized promise through #recorder
8661
8225
  */
8662
- wait(sec: number): Promise<void>;
8226
+ wait(sec: number): Promise<any>;
8663
8227
  /**
8664
8228
  * Executes sync script on a page.
8665
8229
  * Pass arguments to function as additional parameters.
@@ -8809,18 +8373,16 @@ declare namespace CodeceptJS {
8809
8373
  * ```js
8810
8374
  * I.scrollPageToTop();
8811
8375
  * ```
8812
- * @returns automatically synchronized promise through #recorder
8813
8376
  */
8814
- scrollPageToTop(): Promise<void>;
8377
+ scrollPageToTop(): Promise<any>;
8815
8378
  /**
8816
8379
  * Scroll page to the bottom.
8817
8380
  *
8818
8381
  * ```js
8819
8382
  * I.scrollPageToBottom();
8820
8383
  * ```
8821
- * @returns automatically synchronized promise through #recorder
8822
8384
  */
8823
- scrollPageToBottom(): Promise<void>;
8385
+ scrollPageToBottom(): Promise<any>;
8824
8386
  /**
8825
8387
  * Scrolls to element matched by locator.
8826
8388
  * Extra shift can be set with offsetX and offsetY options.
@@ -8832,9 +8394,8 @@ declare namespace CodeceptJS {
8832
8394
  * @param locator - located by CSS|XPath|strict locator.
8833
8395
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
8834
8396
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
8835
- * @returns automatically synchronized promise through #recorder
8836
8397
  */
8837
- scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
8398
+ scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
8838
8399
  /**
8839
8400
  * Switches frame or in case of null locator reverts to parent.
8840
8401
  *
@@ -8843,9 +8404,8 @@ declare namespace CodeceptJS {
8843
8404
  * I.switchTo(); // switch back to main page
8844
8405
  * ```
8845
8406
  * @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
8846
- * @returns automatically synchronized promise through #recorder
8847
8407
  */
8848
- switchTo(locator?: CodeceptJS.LocatorOrString): Promise<void>;
8408
+ switchTo(locator?: CodeceptJS.LocatorOrString): Promise<any>;
8849
8409
  /**
8850
8410
  * Sets cookie(s).
8851
8411
  *
@@ -8861,9 +8421,8 @@ declare namespace CodeceptJS {
8861
8421
  * ]);
8862
8422
  * ```
8863
8423
  * @param cookie - a cookie object or array of cookie objects.
8864
- * @returns automatically synchronized promise through #recorder
8865
8424
  */
8866
- setCookie(cookie: Cookie | Cookie[]): Promise<void>;
8425
+ setCookie(cookie: Cookie | Cookie[]): Promise<any>;
8867
8426
  /**
8868
8427
  * Checks that cookie with given name exists.
8869
8428
  *
@@ -8871,9 +8430,8 @@ declare namespace CodeceptJS {
8871
8430
  * I.seeCookie('Auth');
8872
8431
  * ```
8873
8432
  * @param name - cookie name.
8874
- * @returns automatically synchronized promise through #recorder
8875
8433
  */
8876
- seeCookie(name: string): Promise<void>;
8434
+ seeCookie(name: string): Promise<any>;
8877
8435
  /**
8878
8436
  * Checks that cookie with given name does not exist.
8879
8437
  *
@@ -8881,9 +8439,8 @@ declare namespace CodeceptJS {
8881
8439
  * I.dontSeeCookie('auth'); // no auth cookie
8882
8440
  * ```
8883
8441
  * @param name - cookie name.
8884
- * @returns automatically synchronized promise through #recorder
8885
8442
  */
8886
- dontSeeCookie(name: string): Promise<void>;
8443
+ dontSeeCookie(name: string): Promise<any>;
8887
8444
  /**
8888
8445
  * Gets a cookie object by name.
8889
8446
  * If none provided gets all cookies.
@@ -8902,12 +8459,11 @@ declare namespace CodeceptJS {
8902
8459
  *
8903
8460
  * ```js
8904
8461
  * I.clearCookie();
8905
- * I.clearCookie('test');
8462
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
8906
8463
  * ```
8907
8464
  * @param [cookie = null] - (optional, `null` by default) cookie name
8908
- * @returns automatically synchronized promise through #recorder
8909
8465
  */
8910
- clearCookie(cookie?: string): Promise<void>;
8466
+ clearCookie(cookie?: string): Promise<any>;
8911
8467
  /**
8912
8468
  * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
8913
8469
  *
@@ -8916,9 +8472,8 @@ declare namespace CodeceptJS {
8916
8472
  * ```
8917
8473
  * @param urlPart - value to check.
8918
8474
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
8919
- * @returns automatically synchronized promise through #recorder
8920
8475
  */
8921
- waitInUrl(urlPart: string, sec?: number): Promise<void>;
8476
+ waitInUrl(urlPart: string, sec?: number): Promise<any>;
8922
8477
  /**
8923
8478
  * Waits for the entire URL to match the expected
8924
8479
  *
@@ -8928,9 +8483,8 @@ declare namespace CodeceptJS {
8928
8483
  * ```
8929
8484
  * @param urlPart - value to check.
8930
8485
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
8931
- * @returns automatically synchronized promise through #recorder
8932
8486
  */
8933
- waitUrlEquals(urlPart: string, sec?: number): Promise<void>;
8487
+ waitUrlEquals(urlPart: string, sec?: number): Promise<any>;
8934
8488
  /**
8935
8489
  * Waits for a function to return true (waits for 1 sec by default).
8936
8490
  * Running in browser context.
@@ -8947,9 +8501,8 @@ declare namespace CodeceptJS {
8947
8501
  * @param fn - to be executed in browser context.
8948
8502
  * @param [argsOrSec = null] - (optional, `1` by default) arguments for function or seconds.
8949
8503
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
8950
- * @returns automatically synchronized promise through #recorder
8951
8504
  */
8952
- waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<void>;
8505
+ waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
8953
8506
  /**
8954
8507
  * Waits for a specified number of elements on the page.
8955
8508
  *
@@ -8959,9 +8512,8 @@ declare namespace CodeceptJS {
8959
8512
  * @param locator - element located by CSS|XPath|strict locator.
8960
8513
  * @param num - number of elements.
8961
8514
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
8962
- * @returns automatically synchronized promise through #recorder
8963
8515
  */
8964
- waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<void>;
8516
+ waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<any>;
8965
8517
  /**
8966
8518
  * Waits for element to be present on page (by default waits for 1sec).
8967
8519
  * Element can be located by CSS or XPath.
@@ -8972,9 +8524,8 @@ declare namespace CodeceptJS {
8972
8524
  * ```
8973
8525
  * @param locator - element located by CSS|XPath|strict locator.
8974
8526
  * @param [sec] - (optional, `1` by default) time in seconds to wait
8975
- * @returns automatically synchronized promise through #recorder
8976
8527
  */
8977
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
8528
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
8978
8529
  /**
8979
8530
  * Waits for an element to hide (by default waits for 1sec).
8980
8531
  * Element can be located by CSS or XPath.
@@ -8984,9 +8535,8 @@ declare namespace CodeceptJS {
8984
8535
  * ```
8985
8536
  * @param locator - element located by CSS|XPath|strict locator.
8986
8537
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
8987
- * @returns automatically synchronized promise through #recorder
8988
8538
  */
8989
- waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
8539
+ waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
8990
8540
  /**
8991
8541
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
8992
8542
  * Element can be located by CSS or XPath.
@@ -8996,9 +8546,8 @@ declare namespace CodeceptJS {
8996
8546
  * ```
8997
8547
  * @param locator - element located by CSS|XPath|strict locator.
8998
8548
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
8999
- * @returns automatically synchronized promise through #recorder
9000
8549
  */
9001
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
8550
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
9002
8551
  /**
9003
8552
  * Waits for a text to appear (by default waits for 1sec).
9004
8553
  * Element can be located by CSS or XPath.
@@ -9011,9 +8560,8 @@ declare namespace CodeceptJS {
9011
8560
  * @param text - to wait for.
9012
8561
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
9013
8562
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
9014
- * @returns automatically synchronized promise through #recorder
9015
8563
  */
9016
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
8564
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
9017
8565
  }
9018
8566
  /**
9019
8567
  * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
@@ -9425,9 +8973,8 @@ declare namespace CodeceptJS {
9425
8973
  * I.amOnPage('/login'); // opens a login page
9426
8974
  * ```
9427
8975
  * @param url - url path or global url.
9428
- * @returns automatically synchronized promise through #recorder
9429
8976
  */
9430
- amOnPage(url: string): Promise<void>;
8977
+ amOnPage(url: string): Promise<any>;
9431
8978
  /**
9432
8979
  * Perform a click on a link or a button, given by a locator.
9433
8980
  * If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
@@ -9452,12 +8999,8 @@ declare namespace CodeceptJS {
9452
8999
  * ```
9453
9000
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
9454
9001
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
9455
- * @returns automatically synchronized promise through #recorder
9456
- *
9457
- *
9458
- * {{ react }}
9459
9002
  */
9460
- click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<void>;
9003
+ click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): Promise<any>;
9461
9004
  /**
9462
9005
  * Perform an emulated click on a link or a button, given by a locator.
9463
9006
  * Unlike normal click instead of sending native event, emulates a click with JavaScript.
@@ -9485,12 +9028,8 @@ declare namespace CodeceptJS {
9485
9028
  * ```
9486
9029
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
9487
9030
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
9488
- * @returns automatically synchronized promise through #recorder
9489
- *
9490
- *
9491
- * {{ react }}
9492
9031
  */
9493
- forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
9032
+ forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
9494
9033
  /**
9495
9034
  * Performs a double-click on an element matched by link|button|label|CSS or XPath.
9496
9035
  * Context can be specified as second parameter to narrow search.
@@ -9503,12 +9042,8 @@ declare namespace CodeceptJS {
9503
9042
  * ```
9504
9043
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
9505
9044
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
9506
- * @returns automatically synchronized promise through #recorder
9507
- *
9508
- *
9509
- * {{ react }}
9510
9045
  */
9511
- doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
9046
+ doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
9512
9047
  /**
9513
9048
  * Performs right click on a clickable element matched by semantic locator, CSS or XPath.
9514
9049
  *
@@ -9522,12 +9057,8 @@ declare namespace CodeceptJS {
9522
9057
  * ```
9523
9058
  * @param locator - clickable element located by CSS|XPath|strict locator.
9524
9059
  * @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
9525
- * @returns automatically synchronized promise through #recorder
9526
- *
9527
- *
9528
- * {{ react }}
9529
9060
  */
9530
- rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
9061
+ rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
9531
9062
  /**
9532
9063
  * Emulates right click on an element.
9533
9064
  * Unlike normal click instead of sending native event, emulates a click with JavaScript.
@@ -9545,12 +9076,8 @@ declare namespace CodeceptJS {
9545
9076
  * ```
9546
9077
  * @param locator - clickable link or button located by text, or any element located by CSS|XPath|strict locator.
9547
9078
  * @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
9548
- * @returns automatically synchronized promise through #recorder
9549
- *
9550
- *
9551
- * {{ react }}
9552
9079
  */
9553
- forceRightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
9080
+ forceRightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
9554
9081
  /**
9555
9082
  * Fills a text field or textarea, after clearing its value, with the given string.
9556
9083
  * Field is located by name, label, CSS, or XPath.
@@ -9567,12 +9094,8 @@ declare namespace CodeceptJS {
9567
9094
  * ```
9568
9095
  * @param field - located by label|name|CSS|XPath|strict locator.
9569
9096
  * @param value - text value to fill.
9570
- * @returns automatically synchronized promise through #recorder
9571
- *
9572
- * {{ react }}
9573
- * {{ custom }}
9574
9097
  */
9575
- fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
9098
+ fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
9576
9099
  /**
9577
9100
  * Appends text to a input field or textarea.
9578
9101
  * Field is located by name, label, CSS or XPath
@@ -9584,11 +9107,8 @@ declare namespace CodeceptJS {
9584
9107
  * ```
9585
9108
  * @param field - located by label|name|CSS|XPath|strict locator
9586
9109
  * @param value - text value to append.
9587
- * @returns automatically synchronized promise through #recorder
9588
- *
9589
- * {{ react }}
9590
9110
  */
9591
- appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<void>;
9111
+ appendField(field: CodeceptJS.LocatorOrString, value: string): Promise<any>;
9592
9112
  /**
9593
9113
  * Clears a `<textarea>` or text `<input>` element's value.
9594
9114
  *
@@ -9598,9 +9118,8 @@ declare namespace CodeceptJS {
9598
9118
  * I.clearField('#email');
9599
9119
  * ```
9600
9120
  * @param editable - field located by label|name|CSS|XPath|strict locator.
9601
- * @returns automatically synchronized promise through #recorder.
9602
9121
  */
9603
- clearField(editable: LocatorOrString): Promise<void>;
9122
+ clearField(editable: LocatorOrString): Promise<any>;
9604
9123
  /**
9605
9124
  * Selects an option in a drop-down select.
9606
9125
  * Field is searched by label | name | CSS | XPath.
@@ -9622,9 +9141,8 @@ declare namespace CodeceptJS {
9622
9141
  * ```
9623
9142
  * @param select - field located by label|name|CSS|XPath|strict locator.
9624
9143
  * @param option - visible text or value of option.
9625
- * @returns automatically synchronized promise through #recorder
9626
9144
  */
9627
- selectOption(select: LocatorOrString, option: string | any[]): Promise<void>;
9145
+ selectOption(select: LocatorOrString, option: string | any[]): Promise<any>;
9628
9146
  /**
9629
9147
  * Attaches a file to element located by label, name, CSS or XPath
9630
9148
  * Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
@@ -9636,11 +9154,8 @@ declare namespace CodeceptJS {
9636
9154
  * ```
9637
9155
  * @param locator - field located by label|name|CSS|XPath|strict locator.
9638
9156
  * @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
9639
- * @returns automatically synchronized promise through #recorder
9640
- *
9641
- * Appium: not tested
9642
9157
  */
9643
- attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<void>;
9158
+ attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): Promise<any>;
9644
9159
  /**
9645
9160
  * Selects a checkbox or radio button.
9646
9161
  * Element is located by label or name or CSS or XPath.
@@ -9654,11 +9169,8 @@ declare namespace CodeceptJS {
9654
9169
  * ```
9655
9170
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
9656
9171
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
9657
- * @returns automatically synchronized promise through #recorder
9658
- *
9659
- * Appium: not tested
9660
9172
  */
9661
- checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
9173
+ checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
9662
9174
  /**
9663
9175
  * Unselects a checkbox or radio button.
9664
9176
  * Element is located by label or name or CSS or XPath.
@@ -9672,11 +9184,8 @@ declare namespace CodeceptJS {
9672
9184
  * ```
9673
9185
  * @param field - checkbox located by label | name | CSS | XPath | strict locator.
9674
9186
  * @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
9675
- * @returns automatically synchronized promise through #recorder
9676
- *
9677
- * Appium: not tested
9678
9187
  */
9679
- uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<void>;
9188
+ uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): Promise<any>;
9680
9189
  /**
9681
9190
  * Retrieves all texts from an element located by CSS or XPath and returns it to test.
9682
9191
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -9803,9 +9312,8 @@ declare namespace CodeceptJS {
9803
9312
  * I.seeInTitle('Home Page');
9804
9313
  * ```
9805
9314
  * @param text - text value to check.
9806
- * @returns automatically synchronized promise through #recorder
9807
9315
  */
9808
- seeInTitle(text: string): Promise<void>;
9316
+ seeInTitle(text: string): Promise<any>;
9809
9317
  /**
9810
9318
  * Checks that title is equal to provided one.
9811
9319
  *
@@ -9813,9 +9321,8 @@ declare namespace CodeceptJS {
9813
9321
  * I.seeTitleEquals('Test title.');
9814
9322
  * ```
9815
9323
  * @param text - value to check.
9816
- * @returns automatically synchronized promise through #recorder
9817
9324
  */
9818
- seeTitleEquals(text: string): Promise<void>;
9325
+ seeTitleEquals(text: string): Promise<any>;
9819
9326
  /**
9820
9327
  * Checks that title does not contain text.
9821
9328
  *
@@ -9823,9 +9330,8 @@ declare namespace CodeceptJS {
9823
9330
  * I.dontSeeInTitle('Error');
9824
9331
  * ```
9825
9332
  * @param text - value to check.
9826
- * @returns automatically synchronized promise through #recorder
9827
9333
  */
9828
- dontSeeInTitle(text: string): Promise<void>;
9334
+ dontSeeInTitle(text: string): Promise<any>;
9829
9335
  /**
9830
9336
  * Retrieves a page title and returns it to test.
9831
9337
  * Resumes test execution, so **should be used inside async with `await`** operator.
@@ -9847,12 +9353,8 @@ declare namespace CodeceptJS {
9847
9353
  * ```
9848
9354
  * @param text - expected on page.
9849
9355
  * @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
9850
- * @returns automatically synchronized promise through #recorder
9851
- *
9852
- *
9853
- * {{ react }}
9854
9356
  */
9855
- see(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
9357
+ see(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
9856
9358
  /**
9857
9359
  * Checks that text is equal to provided one.
9858
9360
  *
@@ -9861,9 +9363,8 @@ declare namespace CodeceptJS {
9861
9363
  * ```
9862
9364
  * @param text - element value to check.
9863
9365
  * @param [context = null] - element located by CSS|XPath|strict locator.
9864
- * @returns automatically synchronized promise through #recorder
9865
9366
  */
9866
- seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
9367
+ seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
9867
9368
  /**
9868
9369
  * Opposite to `see`. Checks that a text is not present on a page.
9869
9370
  * Use context parameter to narrow down the search.
@@ -9874,12 +9375,8 @@ declare namespace CodeceptJS {
9874
9375
  * ```
9875
9376
  * @param text - which is not present.
9876
9377
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
9877
- * @returns automatically synchronized promise through #recorder
9878
- *
9879
- *
9880
- * {{ react }}
9881
9378
  */
9882
- dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<void>;
9379
+ dontSee(text: string, context?: CodeceptJS.LocatorOrString): Promise<any>;
9883
9380
  /**
9884
9381
  * Checks that the given input field or textarea equals to given value.
9885
9382
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -9892,9 +9389,8 @@ declare namespace CodeceptJS {
9892
9389
  * ```
9893
9390
  * @param field - located by label|name|CSS|XPath|strict locator.
9894
9391
  * @param value - value to check.
9895
- * @returns automatically synchronized promise through #recorder
9896
9392
  */
9897
- seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
9393
+ seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
9898
9394
  /**
9899
9395
  * Checks that value of input field or textarea doesn't equal to given value
9900
9396
  * Opposite to `seeInField`.
@@ -9905,9 +9401,8 @@ declare namespace CodeceptJS {
9905
9401
  * ```
9906
9402
  * @param field - located by label|name|CSS|XPath|strict locator.
9907
9403
  * @param value - value to check.
9908
- * @returns automatically synchronized promise through #recorder
9909
9404
  */
9910
- dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<void>;
9405
+ dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): Promise<any>;
9911
9406
  /**
9912
9407
  * Verifies that the specified checkbox is checked.
9913
9408
  *
@@ -9917,11 +9412,8 @@ declare namespace CodeceptJS {
9917
9412
  * I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
9918
9413
  * ```
9919
9414
  * @param field - located by label|name|CSS|XPath|strict locator.
9920
- * @returns automatically synchronized promise through #recorder
9921
- *
9922
- * Appium: not tested
9923
9415
  */
9924
- seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
9416
+ seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
9925
9417
  /**
9926
9418
  * Verifies that the specified checkbox is not checked.
9927
9419
  *
@@ -9931,11 +9423,8 @@ declare namespace CodeceptJS {
9931
9423
  * I.dontSeeCheckboxIsChecked('agree'); // located by name
9932
9424
  * ```
9933
9425
  * @param field - located by label|name|CSS|XPath|strict locator.
9934
- * @returns automatically synchronized promise through #recorder
9935
- *
9936
- * Appium: not tested
9937
9426
  */
9938
- dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<void>;
9427
+ dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): Promise<any>;
9939
9428
  /**
9940
9429
  * Checks that a given Element is visible
9941
9430
  * Element is located by CSS or XPath.
@@ -9944,11 +9433,8 @@ declare namespace CodeceptJS {
9944
9433
  * I.seeElement('#modal');
9945
9434
  * ```
9946
9435
  * @param locator - located by CSS|XPath|strict locator.
9947
- * @returns automatically synchronized promise through #recorder
9948
- *
9949
- * {{ react }}
9950
9436
  */
9951
- seeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
9437
+ seeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
9952
9438
  /**
9953
9439
  * Opposite to `seeElement`. Checks that element is not visible (or in DOM)
9954
9440
  *
@@ -9956,11 +9442,8 @@ declare namespace CodeceptJS {
9956
9442
  * I.dontSeeElement('.modal'); // modal is not shown
9957
9443
  * ```
9958
9444
  * @param locator - located by CSS|XPath|Strict locator.
9959
- * @returns automatically synchronized promise through #recorder
9960
- *
9961
- * {{ react }}
9962
9445
  */
9963
- dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<void>;
9446
+ dontSeeElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
9964
9447
  /**
9965
9448
  * Checks that a given Element is present in the DOM
9966
9449
  * Element is located by CSS or XPath.
@@ -9969,9 +9452,8 @@ declare namespace CodeceptJS {
9969
9452
  * I.seeElementInDOM('#modal');
9970
9453
  * ```
9971
9454
  * @param locator - element located by CSS|XPath|strict locator.
9972
- * @returns automatically synchronized promise through #recorder
9973
9455
  */
9974
- seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
9456
+ seeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
9975
9457
  /**
9976
9458
  * Opposite to `seeElementInDOM`. Checks that element is not on page.
9977
9459
  *
@@ -9979,9 +9461,8 @@ declare namespace CodeceptJS {
9979
9461
  * I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
9980
9462
  * ```
9981
9463
  * @param locator - located by CSS|XPath|Strict locator.
9982
- * @returns automatically synchronized promise through #recorder
9983
9464
  */
9984
- dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<void>;
9465
+ dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): Promise<any>;
9985
9466
  /**
9986
9467
  * Checks that the current page contains the given string in its raw source code.
9987
9468
  *
@@ -9989,9 +9470,8 @@ declare namespace CodeceptJS {
9989
9470
  * I.seeInSource('<h1>Green eggs &amp; ham</h1>');
9990
9471
  * ```
9991
9472
  * @param text - value to check.
9992
- * @returns automatically synchronized promise through #recorder
9993
9473
  */
9994
- seeInSource(text: string): Promise<void>;
9474
+ seeInSource(text: string): Promise<any>;
9995
9475
  /**
9996
9476
  * Retrieves page source and returns it to test.
9997
9477
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -10031,9 +9511,8 @@ declare namespace CodeceptJS {
10031
9511
  * I.dontSeeInSource('<!--'); // no comments in source
10032
9512
  * ```
10033
9513
  * @param value - to check.
10034
- * @returns automatically synchronized promise through #recorder
10035
9514
  */
10036
- dontSeeInSource(value: string): Promise<void>;
9515
+ dontSeeInSource(value: string): Promise<any>;
10037
9516
  /**
10038
9517
  * Asserts that an element appears a given number of times in the DOM.
10039
9518
  * Element is located by label or name or CSS or XPath.
@@ -10044,11 +9523,8 @@ declare namespace CodeceptJS {
10044
9523
  * ```
10045
9524
  * @param locator - element located by CSS|XPath|strict locator.
10046
9525
  * @param num - number of elements.
10047
- * @returns automatically synchronized promise through #recorder
10048
- *
10049
- * {{ react }}
10050
9526
  */
10051
- seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
9527
+ seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
10052
9528
  /**
10053
9529
  * Asserts that an element is visible a given number of times.
10054
9530
  * Element is located by CSS or XPath.
@@ -10058,11 +9534,8 @@ declare namespace CodeceptJS {
10058
9534
  * ```
10059
9535
  * @param locator - element located by CSS|XPath|strict locator.
10060
9536
  * @param num - number of elements.
10061
- * @returns automatically synchronized promise through #recorder
10062
- *
10063
- * {{ react }}
10064
9537
  */
10065
- seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<void>;
9538
+ seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): Promise<any>;
10066
9539
  /**
10067
9540
  * Checks that all elements with given locator have given CSS properties.
10068
9541
  *
@@ -10071,9 +9544,8 @@ declare namespace CodeceptJS {
10071
9544
  * ```
10072
9545
  * @param locator - located by CSS|XPath|strict locator.
10073
9546
  * @param cssProperties - object with CSS properties and their values to check.
10074
- * @returns automatically synchronized promise through #recorder
10075
9547
  */
10076
- seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<void>;
9548
+ seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): Promise<any>;
10077
9549
  /**
10078
9550
  * Checks that all elements with given locator have given attributes.
10079
9551
  *
@@ -10082,9 +9554,8 @@ declare namespace CodeceptJS {
10082
9554
  * ```
10083
9555
  * @param locator - located by CSS|XPath|strict locator.
10084
9556
  * @param attributes - attributes and their values to check.
10085
- * @returns automatically synchronized promise through #recorder
10086
9557
  */
10087
- seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<void>;
9558
+ seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): Promise<any>;
10088
9559
  /**
10089
9560
  * Grab number of visible elements by locator.
10090
9561
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -10103,15 +9574,13 @@ declare namespace CodeceptJS {
10103
9574
  * I.seeInCurrentUrl('/register'); // we are on registration page
10104
9575
  * ```
10105
9576
  * @param url - a fragment to check
10106
- * @returns automatically synchronized promise through #recorder
10107
9577
  */
10108
- seeInCurrentUrl(url: string): Promise<void>;
9578
+ seeInCurrentUrl(url: string): Promise<any>;
10109
9579
  /**
10110
9580
  * Checks that current url does not contain a provided fragment.
10111
9581
  * @param url - value to check.
10112
- * @returns automatically synchronized promise through #recorder
10113
9582
  */
10114
- dontSeeInCurrentUrl(url: string): Promise<void>;
9583
+ dontSeeInCurrentUrl(url: string): Promise<any>;
10115
9584
  /**
10116
9585
  * Checks that current url is equal to provided one.
10117
9586
  * If a relative url provided, a configured url will be prepended to it.
@@ -10122,9 +9591,8 @@ declare namespace CodeceptJS {
10122
9591
  * I.seeCurrentUrlEquals('http://my.site.com/register');
10123
9592
  * ```
10124
9593
  * @param url - value to check.
10125
- * @returns automatically synchronized promise through #recorder
10126
9594
  */
10127
- seeCurrentUrlEquals(url: string): Promise<void>;
9595
+ seeCurrentUrlEquals(url: string): Promise<any>;
10128
9596
  /**
10129
9597
  * Checks that current url is not equal to provided one.
10130
9598
  * If a relative url provided, a configured url will be prepended to it.
@@ -10134,9 +9602,8 @@ declare namespace CodeceptJS {
10134
9602
  * I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
10135
9603
  * ```
10136
9604
  * @param url - value to check.
10137
- * @returns automatically synchronized promise through #recorder
10138
9605
  */
10139
- dontSeeCurrentUrlEquals(url: string): Promise<void>;
9606
+ dontSeeCurrentUrlEquals(url: string): Promise<any>;
10140
9607
  /**
10141
9608
  * Executes sync script on a page.
10142
9609
  * Pass arguments to function as additional parameters.
@@ -10205,9 +9672,8 @@ declare namespace CodeceptJS {
10205
9672
  * ```
10206
9673
  * @param locator - located by CSS|XPath|strict locator.
10207
9674
  * @param scrollIntoViewOptions - see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
10208
- * @returns automatically synchronized promise through #recorder
10209
9675
  */
10210
- scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): Promise<void>;
9676
+ scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): Promise<any>;
10211
9677
  /**
10212
9678
  * Scrolls to element matched by locator.
10213
9679
  * Extra shift can be set with offsetX and offsetY options.
@@ -10219,9 +9685,8 @@ declare namespace CodeceptJS {
10219
9685
  * @param locator - located by CSS|XPath|strict locator.
10220
9686
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
10221
9687
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
10222
- * @returns automatically synchronized promise through #recorder
10223
9688
  */
10224
- scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
9689
+ scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
10225
9690
  /**
10226
9691
  * Moves cursor to element matched by locator.
10227
9692
  * Extra shift can be set with offsetX and offsetY options.
@@ -10233,9 +9698,8 @@ declare namespace CodeceptJS {
10233
9698
  * @param locator - located by CSS|XPath|strict locator.
10234
9699
  * @param [offsetX = 0] - (optional, `0` by default) X-axis offset.
10235
9700
  * @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
10236
- * @returns automatically synchronized promise through #recorder
10237
9701
  */
10238
- moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<void>;
9702
+ moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): Promise<any>;
10239
9703
  /**
10240
9704
  * Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
10241
9705
  * Filename is relative to output folder.
@@ -10245,9 +9709,8 @@ declare namespace CodeceptJS {
10245
9709
  * ```
10246
9710
  * @param locator - element located by CSS|XPath|strict locator.
10247
9711
  * @param fileName - file name to save.
10248
- * @returns automatically synchronized promise through #recorder
10249
9712
  */
10250
- saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<void>;
9713
+ saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): Promise<any>;
10251
9714
  /**
10252
9715
  * Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
10253
9716
  * Filename is relative to output folder.
@@ -10259,9 +9722,8 @@ declare namespace CodeceptJS {
10259
9722
  * ```
10260
9723
  * @param fileName - file name to save.
10261
9724
  * @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
10262
- * @returns automatically synchronized promise through #recorder
10263
9725
  */
10264
- saveScreenshot(fileName: string, fullPage?: boolean): Promise<void>;
9726
+ saveScreenshot(fileName: string, fullPage?: boolean): Promise<any>;
10265
9727
  /**
10266
9728
  * Sets cookie(s).
10267
9729
  *
@@ -10277,26 +9739,19 @@ declare namespace CodeceptJS {
10277
9739
  * ]);
10278
9740
  * ```
10279
9741
  * @param cookie - a cookie object or array of cookie objects.
10280
- * @returns automatically synchronized promise through #recorder
10281
- *
10282
- *
10283
- *
10284
- * Uses Selenium's JSON [cookie
10285
- * format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
10286
9742
  */
10287
- setCookie(cookie: Cookie | Cookie[]): Promise<void>;
9743
+ setCookie(cookie: Cookie | Cookie[]): Promise<any>;
10288
9744
  /**
10289
9745
  * Clears a cookie by name,
10290
9746
  * if none provided clears all cookies.
10291
9747
  *
10292
9748
  * ```js
10293
9749
  * I.clearCookie();
10294
- * I.clearCookie('test');
9750
+ * I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
10295
9751
  * ```
10296
9752
  * @param [cookie = null] - (optional, `null` by default) cookie name
10297
- * @returns automatically synchronized promise through #recorder
10298
9753
  */
10299
- clearCookie(cookie?: string): Promise<void>;
9754
+ clearCookie(cookie?: string): Promise<any>;
10300
9755
  /**
10301
9756
  * Checks that cookie with given name exists.
10302
9757
  *
@@ -10304,9 +9759,8 @@ declare namespace CodeceptJS {
10304
9759
  * I.seeCookie('Auth');
10305
9760
  * ```
10306
9761
  * @param name - cookie name.
10307
- * @returns automatically synchronized promise through #recorder
10308
9762
  */
10309
- seeCookie(name: string): Promise<void>;
9763
+ seeCookie(name: string): Promise<any>;
10310
9764
  /**
10311
9765
  * Checks that cookie with given name does not exist.
10312
9766
  *
@@ -10314,9 +9768,8 @@ declare namespace CodeceptJS {
10314
9768
  * I.dontSeeCookie('auth'); // no auth cookie
10315
9769
  * ```
10316
9770
  * @param name - cookie name.
10317
- * @returns automatically synchronized promise through #recorder
10318
9771
  */
10319
- dontSeeCookie(name: string): Promise<void>;
9772
+ dontSeeCookie(name: string): Promise<any>;
10320
9773
  /**
10321
9774
  * Gets a cookie object by name.
10322
9775
  * If none provided gets all cookies.
@@ -10363,9 +9816,8 @@ declare namespace CodeceptJS {
10363
9816
  * I.pressKeyUp('Control');
10364
9817
  * ```
10365
9818
  * @param key - name of key to press down.
10366
- * @returns automatically synchronized promise through #recorder
10367
9819
  */
10368
- pressKeyDown(key: string): Promise<void>;
9820
+ pressKeyDown(key: string): Promise<any>;
10369
9821
  /**
10370
9822
  * Releases a key in the browser which was previously set to a down state.
10371
9823
  *
@@ -10377,9 +9829,8 @@ declare namespace CodeceptJS {
10377
9829
  * I.pressKeyUp('Control');
10378
9830
  * ```
10379
9831
  * @param key - name of key to release.
10380
- * @returns automatically synchronized promise through #recorder
10381
9832
  */
10382
- pressKeyUp(key: string): Promise<void>;
9833
+ pressKeyUp(key: string): Promise<any>;
10383
9834
  /**
10384
9835
  * Presses a key in the browser (on a focused element).
10385
9836
  *
@@ -10439,12 +9890,8 @@ declare namespace CodeceptJS {
10439
9890
  * - `'Space'`
10440
9891
  * - `'Tab'`
10441
9892
  * @param key - key or array of keys to press.
10442
- * @returns automatically synchronized promise through #recorder
10443
- *
10444
- *
10445
- * _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.
10446
9893
  */
10447
- pressKey(key: string | string[]): Promise<void>;
9894
+ pressKey(key: string | string[]): Promise<any>;
10448
9895
  /**
10449
9896
  * Types out the given text into an active field.
10450
9897
  * To slow down typing use a second parameter, to set interval between key presses.
@@ -10465,19 +9912,15 @@ declare namespace CodeceptJS {
10465
9912
  * ```
10466
9913
  * @param key - or array of keys to type.
10467
9914
  * @param [delay = null] - (optional) delay in ms between key presses
10468
- * @returns automatically synchronized promise through #recorder
10469
9915
  */
10470
- type(key: string | string[], delay?: number): Promise<void>;
9916
+ type(key: string | string[], delay?: number): Promise<any>;
10471
9917
  /**
10472
9918
  * Resize the current window to provided width and height.
10473
9919
  * First parameter can be set to `maximize`.
10474
9920
  * @param width - width in pixels or `maximize`.
10475
9921
  * @param height - height in pixels.
10476
- * @returns automatically synchronized promise through #recorder
10477
- *
10478
- * Appium: not tested in web, in apps doesn't work
10479
9922
  */
10480
- resizeWindow(width: number, height: number): Promise<void>;
9923
+ resizeWindow(width: number, height: number): Promise<any>;
10481
9924
  /**
10482
9925
  * Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
10483
9926
  *
@@ -10490,9 +9933,8 @@ declare namespace CodeceptJS {
10490
9933
  * ```
10491
9934
  * @param locator - field located by label|name|CSS|XPath|strict locator.
10492
9935
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
10493
- * @returns automatically synchronized promise through #recorder
10494
9936
  */
10495
- focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
9937
+ focus(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
10496
9938
  /**
10497
9939
  * Remove focus from a text input, button, etc.
10498
9940
  * Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
@@ -10510,9 +9952,8 @@ declare namespace CodeceptJS {
10510
9952
  * ```
10511
9953
  * @param locator - field located by label|name|CSS|XPath|strict locator.
10512
9954
  * @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
10513
- * @returns automatically synchronized promise through #recorder
10514
9955
  */
10515
- blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<void>;
9956
+ blur(locator: CodeceptJS.LocatorOrString, options?: any): Promise<any>;
10516
9957
  /**
10517
9958
  * Drag an item to a destination element.
10518
9959
  *
@@ -10521,11 +9962,8 @@ declare namespace CodeceptJS {
10521
9962
  * ```
10522
9963
  * @param srcElement - located by CSS|XPath|strict locator.
10523
9964
  * @param destElement - located by CSS|XPath|strict locator.
10524
- * @returns automatically synchronized promise through #recorder
10525
- *
10526
- * Appium: not tested
10527
9965
  */
10528
- dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): Promise<void>;
9966
+ dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): Promise<any>;
10529
9967
  /**
10530
9968
  * Drag the scrubber of a slider to a given position
10531
9969
  * For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
@@ -10536,9 +9974,8 @@ declare namespace CodeceptJS {
10536
9974
  * ```
10537
9975
  * @param locator - located by label|name|CSS|XPath|strict locator.
10538
9976
  * @param offsetX - position to drag.
10539
- * @returns automatically synchronized promise through #recorder
10540
9977
  */
10541
- dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): Promise<void>;
9978
+ dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): Promise<any>;
10542
9979
  /**
10543
9980
  * Get all Window Handles.
10544
9981
  * Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
@@ -10578,9 +10015,8 @@ declare namespace CodeceptJS {
10578
10015
  * ```js
10579
10016
  * I.closeOtherTabs();
10580
10017
  * ```
10581
- * @returns automatically synchronized promise through #recorder
10582
10018
  */
10583
- closeOtherTabs(): Promise<void>;
10019
+ closeOtherTabs(): Promise<any>;
10584
10020
  /**
10585
10021
  * Pauses execution for a number of seconds.
10586
10022
  *
@@ -10588,17 +10024,15 @@ declare namespace CodeceptJS {
10588
10024
  * I.wait(2); // wait 2 secs
10589
10025
  * ```
10590
10026
  * @param sec - number of second to wait.
10591
- * @returns automatically synchronized promise through #recorder
10592
10027
  */
10593
- wait(sec: number): Promise<void>;
10028
+ wait(sec: number): Promise<any>;
10594
10029
  /**
10595
10030
  * Waits for element to become enabled (by default waits for 1sec).
10596
10031
  * Element can be located by CSS or XPath.
10597
10032
  * @param locator - element located by CSS|XPath|strict locator.
10598
10033
  * @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
10599
- * @returns automatically synchronized promise through #recorder
10600
10034
  */
10601
- waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10035
+ waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10602
10036
  /**
10603
10037
  * Waits for element to be present on page (by default waits for 1sec).
10604
10038
  * Element can be located by CSS or XPath.
@@ -10609,9 +10043,8 @@ declare namespace CodeceptJS {
10609
10043
  * ```
10610
10044
  * @param locator - element located by CSS|XPath|strict locator.
10611
10045
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
10612
- * @returns automatically synchronized promise through #recorder
10613
10046
  */
10614
- waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10047
+ waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10615
10048
  /**
10616
10049
  * Waits for element to be clickable (by default waits for 1sec).
10617
10050
  * Element can be located by CSS or XPath.
@@ -10622,9 +10055,8 @@ declare namespace CodeceptJS {
10622
10055
  * ```
10623
10056
  * @param locator - element located by CSS|XPath|strict locator.
10624
10057
  * @param [sec] - (optional, `1` by default) time in seconds to wait
10625
- * @returns automatically synchronized promise through #recorder
10626
10058
  */
10627
- waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10059
+ waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10628
10060
  /**
10629
10061
  * Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
10630
10062
  *
@@ -10633,9 +10065,8 @@ declare namespace CodeceptJS {
10633
10065
  * ```
10634
10066
  * @param urlPart - value to check.
10635
10067
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10636
- * @returns automatically synchronized promise through #recorder
10637
10068
  */
10638
- waitInUrl(urlPart: string, sec?: number): Promise<void>;
10069
+ waitInUrl(urlPart: string, sec?: number): Promise<any>;
10639
10070
  /**
10640
10071
  * Waits for the entire URL to match the expected
10641
10072
  *
@@ -10645,9 +10076,8 @@ declare namespace CodeceptJS {
10645
10076
  * ```
10646
10077
  * @param urlPart - value to check.
10647
10078
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10648
- * @returns automatically synchronized promise through #recorder
10649
10079
  */
10650
- waitUrlEquals(urlPart: string, sec?: number): Promise<void>;
10080
+ waitUrlEquals(urlPart: string, sec?: number): Promise<any>;
10651
10081
  /**
10652
10082
  * Waits for a text to appear (by default waits for 1sec).
10653
10083
  * Element can be located by CSS or XPath.
@@ -10660,9 +10090,8 @@ declare namespace CodeceptJS {
10660
10090
  * @param text - to wait for.
10661
10091
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10662
10092
  * @param [context = null] - (optional) element located by CSS|XPath|strict locator.
10663
- * @returns automatically synchronized promise through #recorder
10664
10093
  */
10665
- waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<void>;
10094
+ waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): Promise<any>;
10666
10095
  /**
10667
10096
  * Waits for the specified value to be in value attribute.
10668
10097
  *
@@ -10672,9 +10101,8 @@ declare namespace CodeceptJS {
10672
10101
  * @param field - input field.
10673
10102
  * @param value - expected value.
10674
10103
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10675
- * @returns automatically synchronized promise through #recorder
10676
10104
  */
10677
- waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<void>;
10105
+ waitForValue(field: LocatorOrString, value: string, sec?: number): Promise<any>;
10678
10106
  /**
10679
10107
  * Waits for an element to become visible on a page (by default waits for 1sec).
10680
10108
  * Element can be located by CSS or XPath.
@@ -10684,9 +10112,8 @@ declare namespace CodeceptJS {
10684
10112
  * ```
10685
10113
  * @param locator - element located by CSS|XPath|strict locator.
10686
10114
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10687
- * @returns automatically synchronized promise through #recorder
10688
10115
  */
10689
- waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10116
+ waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10690
10117
  /**
10691
10118
  * Waits for a specified number of elements on the page.
10692
10119
  *
@@ -10696,9 +10123,8 @@ declare namespace CodeceptJS {
10696
10123
  * @param locator - element located by CSS|XPath|strict locator.
10697
10124
  * @param num - number of elements.
10698
10125
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10699
- * @returns automatically synchronized promise through #recorder
10700
10126
  */
10701
- waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<void>;
10127
+ waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): Promise<any>;
10702
10128
  /**
10703
10129
  * Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
10704
10130
  * Element can be located by CSS or XPath.
@@ -10708,9 +10134,8 @@ declare namespace CodeceptJS {
10708
10134
  * ```
10709
10135
  * @param locator - element located by CSS|XPath|strict locator.
10710
10136
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10711
- * @returns automatically synchronized promise through #recorder
10712
10137
  */
10713
- waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10138
+ waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10714
10139
  /**
10715
10140
  * Waits for an element to hide (by default waits for 1sec).
10716
10141
  * Element can be located by CSS or XPath.
@@ -10720,9 +10145,8 @@ declare namespace CodeceptJS {
10720
10145
  * ```
10721
10146
  * @param locator - element located by CSS|XPath|strict locator.
10722
10147
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10723
- * @returns automatically synchronized promise through #recorder
10724
10148
  */
10725
- waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10149
+ waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10726
10150
  /**
10727
10151
  * Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
10728
10152
  * Element can be located by CSS or XPath.
@@ -10732,9 +10156,8 @@ declare namespace CodeceptJS {
10732
10156
  * ```
10733
10157
  * @param locator - element located by CSS|XPath|strict locator.
10734
10158
  * @param [sec = 1] - (optional, `1` by default) time in seconds to wait
10735
- * @returns automatically synchronized promise through #recorder
10736
10159
  */
10737
- waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<void>;
10160
+ waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): Promise<any>;
10738
10161
  /**
10739
10162
  * Waits for a function to return true (waits for 1 sec by default).
10740
10163
  * Running in browser context.
@@ -10751,9 +10174,8 @@ declare namespace CodeceptJS {
10751
10174
  * @param fn - to be executed in browser context.
10752
10175
  * @param [argsOrSec = null] - (optional, `1` by default) arguments for function or seconds.
10753
10176
  * @param [sec = null] - (optional, `1` by default) time in seconds to wait
10754
- * @returns automatically synchronized promise through #recorder
10755
10177
  */
10756
- waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<void>;
10178
+ waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): Promise<any>;
10757
10179
  /**
10758
10180
  * Switches frame or in case of null locator reverts to parent.
10759
10181
  *
@@ -10762,9 +10184,8 @@ declare namespace CodeceptJS {
10762
10184
  * I.switchTo(); // switch back to main page
10763
10185
  * ```
10764
10186
  * @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
10765
- * @returns automatically synchronized promise through #recorder
10766
10187
  */
10767
- switchTo(locator?: CodeceptJS.LocatorOrString): Promise<void>;
10188
+ switchTo(locator?: CodeceptJS.LocatorOrString): Promise<any>;
10768
10189
  /**
10769
10190
  * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
10770
10191
  *
@@ -10774,9 +10195,8 @@ declare namespace CodeceptJS {
10774
10195
  * ```
10775
10196
  * @param [num = 1] - (optional) number of tabs to switch forward, default: 1.
10776
10197
  * @param [sec = null] - (optional) time in seconds to wait.
10777
- * @returns automatically synchronized promise through #recorder
10778
10198
  */
10779
- switchToNextTab(num?: number, sec?: number | null): Promise<void>;
10199
+ switchToNextTab(num?: number, sec?: number | null): Promise<any>;
10780
10200
  /**
10781
10201
  * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
10782
10202
  *
@@ -10786,27 +10206,24 @@ declare namespace CodeceptJS {
10786
10206
  * ```
10787
10207
  * @param [num = 1] - (optional) number of tabs to switch backward, default: 1.
10788
10208
  * @param [sec = null] - (optional) time in seconds to wait.
10789
- * @returns automatically synchronized promise through #recorder
10790
10209
  */
10791
- switchToPreviousTab(num?: number, sec?: number): Promise<void>;
10210
+ switchToPreviousTab(num?: number, sec?: number): Promise<any>;
10792
10211
  /**
10793
10212
  * Close current tab.
10794
10213
  *
10795
10214
  * ```js
10796
10215
  * I.closeCurrentTab();
10797
10216
  * ```
10798
- * @returns automatically synchronized promise through #recorder
10799
10217
  */
10800
- closeCurrentTab(): Promise<void>;
10218
+ closeCurrentTab(): Promise<any>;
10801
10219
  /**
10802
10220
  * Open new tab and switch to it.
10803
10221
  *
10804
10222
  * ```js
10805
10223
  * I.openNewTab();
10806
10224
  * ```
10807
- * @returns automatically synchronized promise through #recorder
10808
10225
  */
10809
- openNewTab(): Promise<void>;
10226
+ openNewTab(): Promise<any>;
10810
10227
  /**
10811
10228
  * Grab number of open tabs.
10812
10229
  * Resumes test execution, so **should be used inside async function with `await`** operator.
@@ -10823,27 +10240,24 @@ declare namespace CodeceptJS {
10823
10240
  * ```js
10824
10241
  * I.refreshPage();
10825
10242
  * ```
10826
- * @returns automatically synchronized promise through #recorder
10827
10243
  */
10828
- refreshPage(): Promise<void>;
10244
+ refreshPage(): Promise<any>;
10829
10245
  /**
10830
10246
  * Scroll page to the top.
10831
10247
  *
10832
10248
  * ```js
10833
10249
  * I.scrollPageToTop();
10834
10250
  * ```
10835
- * @returns automatically synchronized promise through #recorder
10836
10251
  */
10837
- scrollPageToTop(): Promise<void>;
10252
+ scrollPageToTop(): Promise<any>;
10838
10253
  /**
10839
10254
  * Scroll page to the bottom.
10840
10255
  *
10841
10256
  * ```js
10842
10257
  * I.scrollPageToBottom();
10843
10258
  * ```
10844
- * @returns automatically synchronized promise through #recorder
10845
10259
  */
10846
- scrollPageToBottom(): Promise<void>;
10260
+ scrollPageToBottom(): Promise<any>;
10847
10261
  /**
10848
10262
  * Retrieves a page scroll position and returns it to test.
10849
10263
  * Resumes test execution, so **should be used inside an async function with `await`** operator.
@@ -10865,9 +10279,8 @@ declare namespace CodeceptJS {
10865
10279
  * @param latitude - to set.
10866
10280
  * @param longitude - to set
10867
10281
  * @param [altitude = null] - (optional, null by default) to set
10868
- * @returns automatically synchronized promise through #recorder
10869
10282
  */
10870
- setGeoLocation(latitude: number, longitude: number, altitude?: number): Promise<void>;
10283
+ setGeoLocation(latitude: number, longitude: number, altitude?: number): Promise<any>;
10871
10284
  /**
10872
10285
  * Return the current geo location
10873
10286
  * Resumes test execution, so **should be used inside async function with `await`** operator.