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