codeceptjs 3.5.7 → 3.5.9-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/docs/build/Appium.js +27 -22
- package/docs/build/Nightmare.js +51 -52
- package/docs/build/Playwright.js +75 -75
- package/docs/build/Protractor.js +64 -65
- package/docs/build/Puppeteer.js +74 -75
- package/docs/build/TestCafe.js +54 -55
- package/docs/build/WebDriver.js +79 -80
- package/docs/changelog.md +1 -562
- package/docs/community-helpers.md +4 -8
- package/docs/examples.md +2 -8
- package/docs/helpers/Appium.md +85 -83
- package/docs/helpers/Nightmare.md +75 -77
- package/docs/helpers/Playwright.md +175 -177
- package/docs/helpers/Protractor.md +153 -155
- package/docs/helpers/Puppeteer.md +146 -148
- package/docs/helpers/TestCafe.md +124 -126
- package/docs/helpers/WebDriver.md +155 -157
- package/docs/webapi/amOnPage.mustache +1 -1
- package/docs/webapi/appendField.mustache +1 -1
- package/docs/webapi/attachFile.mustache +1 -1
- package/docs/webapi/blur.mustache +1 -1
- package/docs/webapi/checkOption.mustache +1 -1
- package/docs/webapi/clearCookie.mustache +1 -2
- package/docs/webapi/clearField.mustache +1 -1
- package/docs/webapi/click.mustache +1 -1
- package/docs/webapi/clickLink.mustache +1 -1
- package/docs/webapi/closeCurrentTab.mustache +1 -1
- package/docs/webapi/closeOtherTabs.mustache +1 -1
- package/docs/webapi/dontSee.mustache +1 -1
- package/docs/webapi/dontSeeCheckboxIsChecked.mustache +1 -1
- package/docs/webapi/dontSeeCookie.mustache +1 -1
- package/docs/webapi/dontSeeCurrentUrlEquals.mustache +1 -1
- package/docs/webapi/dontSeeElement.mustache +1 -1
- package/docs/webapi/dontSeeElementInDOM.mustache +1 -1
- package/docs/webapi/dontSeeInCurrentUrl.mustache +1 -1
- package/docs/webapi/dontSeeInField.mustache +1 -1
- package/docs/webapi/dontSeeInSource.mustache +1 -1
- package/docs/webapi/dontSeeInTitle.mustache +1 -1
- package/docs/webapi/doubleClick.mustache +1 -1
- package/docs/webapi/downloadFile.mustache +1 -1
- package/docs/webapi/dragAndDrop.mustache +1 -1
- package/docs/webapi/dragSlider.mustache +1 -1
- package/docs/webapi/fillField.mustache +1 -1
- package/docs/webapi/focus.mustache +1 -1
- package/docs/webapi/forceClick.mustache +1 -1
- package/docs/webapi/forceRightClick.mustache +1 -1
- package/docs/webapi/grabDataFromPerformanceTiming.mustache +1 -1
- package/docs/webapi/moveCursorTo.mustache +1 -1
- package/docs/webapi/openNewTab.mustache +1 -1
- package/docs/webapi/pressKey.mustache +1 -1
- package/docs/webapi/pressKeyDown.mustache +1 -1
- package/docs/webapi/pressKeyUp.mustache +1 -1
- package/docs/webapi/pressKeyWithKeyNormalization.mustache +1 -1
- package/docs/webapi/refreshPage.mustache +1 -1
- package/docs/webapi/resizeWindow.mustache +1 -1
- package/docs/webapi/rightClick.mustache +1 -1
- package/docs/webapi/saveElementScreenshot.mustache +1 -1
- package/docs/webapi/saveScreenshot.mustache +1 -1
- package/docs/webapi/say.mustache +1 -1
- package/docs/webapi/scrollIntoView.mustache +1 -1
- package/docs/webapi/scrollPageToBottom.mustache +1 -1
- package/docs/webapi/scrollPageToTop.mustache +1 -1
- package/docs/webapi/scrollTo.mustache +1 -1
- package/docs/webapi/see.mustache +1 -1
- package/docs/webapi/seeAttributesOnElements.mustache +1 -1
- package/docs/webapi/seeCheckboxIsChecked.mustache +1 -1
- package/docs/webapi/seeCookie.mustache +1 -1
- package/docs/webapi/seeCssPropertiesOnElements.mustache +1 -1
- package/docs/webapi/seeCurrentUrlEquals.mustache +1 -1
- package/docs/webapi/seeElement.mustache +1 -1
- package/docs/webapi/seeElementInDOM.mustache +1 -1
- package/docs/webapi/seeInCurrentUrl.mustache +1 -1
- package/docs/webapi/seeInField.mustache +1 -1
- package/docs/webapi/seeInPopup.mustache +1 -1
- package/docs/webapi/seeInSource.mustache +1 -1
- package/docs/webapi/seeInTitle.mustache +1 -1
- package/docs/webapi/seeNumberOfElements.mustache +1 -1
- package/docs/webapi/seeNumberOfVisibleElements.mustache +1 -1
- package/docs/webapi/seeTextEquals.mustache +1 -1
- package/docs/webapi/seeTitleEquals.mustache +1 -1
- package/docs/webapi/selectOption.mustache +1 -1
- package/docs/webapi/setCookie.mustache +1 -1
- package/docs/webapi/setGeoLocation.mustache +1 -1
- package/docs/webapi/switchTo.mustache +1 -1
- package/docs/webapi/switchToNextTab.mustache +1 -1
- package/docs/webapi/switchToPreviousTab.mustache +1 -1
- package/docs/webapi/type.mustache +1 -1
- package/docs/webapi/uncheckOption.mustache +1 -1
- package/docs/webapi/wait.mustache +1 -1
- package/docs/webapi/waitForClickable.mustache +1 -1
- package/docs/webapi/waitForDetached.mustache +1 -1
- package/docs/webapi/waitForElement.mustache +1 -1
- package/docs/webapi/waitForEnabled.mustache +1 -1
- package/docs/webapi/waitForFunction.mustache +1 -1
- package/docs/webapi/waitForInvisible.mustache +1 -1
- package/docs/webapi/waitForText.mustache +1 -1
- package/docs/webapi/waitForValue.mustache +1 -1
- package/docs/webapi/waitForVisible.mustache +1 -1
- package/docs/webapi/waitInUrl.mustache +1 -1
- package/docs/webapi/waitNumberOfVisibleElements.mustache +1 -1
- package/docs/webapi/waitToHide.mustache +1 -1
- package/docs/webapi/waitUrlEquals.mustache +1 -1
- package/lib/helper/Appium.js +9 -4
- package/lib/helper/Playwright.js +3 -2
- package/package.json +5 -5
- package/typings/promiseBasedTypes.d.ts +423 -1010
- package/typings/types.d.ts +423 -427
package/typings/types.d.ts
CHANGED
|
@@ -508,10 +508,12 @@ declare namespace CodeceptJS {
|
|
|
508
508
|
* I.setNetworkConnection(4) // airplane mode off, wifi off, data on
|
|
509
509
|
* I.setNetworkConnection(6) // airplane mode off, wifi on, data on
|
|
510
510
|
* ```
|
|
511
|
-
* See corresponding [webdriverio reference](
|
|
512
|
-
*
|
|
511
|
+
* See corresponding [webdriverio reference](https://webdriver.io/docs/api/chromium/#setnetworkconnection).
|
|
512
|
+
*
|
|
513
|
+
* Appium: support only Android
|
|
514
|
+
* @param value - The network connection mode bitmask
|
|
513
515
|
*/
|
|
514
|
-
setNetworkConnection(): Promise<
|
|
516
|
+
setNetworkConnection(value: number): Promise<number>;
|
|
515
517
|
/**
|
|
516
518
|
* Update the current setting on the device
|
|
517
519
|
*
|
|
@@ -763,7 +765,7 @@ declare namespace CodeceptJS {
|
|
|
763
765
|
* @param value - text value to append.
|
|
764
766
|
* @returns automatically synchronized promise through #recorder
|
|
765
767
|
*/
|
|
766
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
768
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
767
769
|
/**
|
|
768
770
|
* Selects a checkbox or radio button.
|
|
769
771
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -779,7 +781,7 @@ declare namespace CodeceptJS {
|
|
|
779
781
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
780
782
|
* @returns automatically synchronized promise through #recorder
|
|
781
783
|
*/
|
|
782
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
784
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
783
785
|
/**
|
|
784
786
|
* Perform a click on a link or a button, given by a locator.
|
|
785
787
|
* If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
|
|
@@ -806,7 +808,7 @@ declare namespace CodeceptJS {
|
|
|
806
808
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
807
809
|
* @returns automatically synchronized promise through #recorder
|
|
808
810
|
*/
|
|
809
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null):
|
|
811
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
|
|
810
812
|
/**
|
|
811
813
|
* Verifies that the specified checkbox is not checked.
|
|
812
814
|
*
|
|
@@ -818,7 +820,7 @@ declare namespace CodeceptJS {
|
|
|
818
820
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
819
821
|
* @returns automatically synchronized promise through #recorder
|
|
820
822
|
*/
|
|
821
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
823
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
822
824
|
/**
|
|
823
825
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
824
826
|
*
|
|
@@ -828,7 +830,7 @@ declare namespace CodeceptJS {
|
|
|
828
830
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
829
831
|
* @returns automatically synchronized promise through #recorder
|
|
830
832
|
*/
|
|
831
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
833
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
832
834
|
/**
|
|
833
835
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
834
836
|
* Opposite to `seeInField`.
|
|
@@ -841,7 +843,7 @@ declare namespace CodeceptJS {
|
|
|
841
843
|
* @param value - value to check.
|
|
842
844
|
* @returns automatically synchronized promise through #recorder
|
|
843
845
|
*/
|
|
844
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
846
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
845
847
|
/**
|
|
846
848
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
847
849
|
* Use context parameter to narrow down the search.
|
|
@@ -854,7 +856,7 @@ declare namespace CodeceptJS {
|
|
|
854
856
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
855
857
|
* @returns automatically synchronized promise through #recorder
|
|
856
858
|
*/
|
|
857
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
859
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
858
860
|
/**
|
|
859
861
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
860
862
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -873,7 +875,7 @@ declare namespace CodeceptJS {
|
|
|
873
875
|
* @param value - text value to fill.
|
|
874
876
|
* @returns automatically synchronized promise through #recorder
|
|
875
877
|
*/
|
|
876
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
878
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
877
879
|
/**
|
|
878
880
|
* Retrieves all texts from an element located by CSS or XPath and returns it to test.
|
|
879
881
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -984,7 +986,7 @@ declare namespace CodeceptJS {
|
|
|
984
986
|
*
|
|
985
987
|
* Supported only for web testing
|
|
986
988
|
*/
|
|
987
|
-
scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions):
|
|
989
|
+
scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): void;
|
|
988
990
|
/**
|
|
989
991
|
* Verifies that the specified checkbox is checked.
|
|
990
992
|
*
|
|
@@ -996,7 +998,7 @@ declare namespace CodeceptJS {
|
|
|
996
998
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
997
999
|
* @returns automatically synchronized promise through #recorder
|
|
998
1000
|
*/
|
|
999
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
1001
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
1000
1002
|
/**
|
|
1001
1003
|
* Checks that a given Element is visible
|
|
1002
1004
|
* Element is located by CSS or XPath.
|
|
@@ -1007,7 +1009,7 @@ declare namespace CodeceptJS {
|
|
|
1007
1009
|
* @param locator - located by CSS|XPath|strict locator.
|
|
1008
1010
|
* @returns automatically synchronized promise through #recorder
|
|
1009
1011
|
*/
|
|
1010
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
1012
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
1011
1013
|
/**
|
|
1012
1014
|
* Checks that the given input field or textarea equals to given value.
|
|
1013
1015
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -1022,7 +1024,7 @@ declare namespace CodeceptJS {
|
|
|
1022
1024
|
* @param value - value to check.
|
|
1023
1025
|
* @returns automatically synchronized promise through #recorder
|
|
1024
1026
|
*/
|
|
1025
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
1027
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
1026
1028
|
/**
|
|
1027
1029
|
* Checks that a page contains a visible text.
|
|
1028
1030
|
* Use context parameter to narrow down the search.
|
|
@@ -1036,7 +1038,7 @@ declare namespace CodeceptJS {
|
|
|
1036
1038
|
* @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
1037
1039
|
* @returns automatically synchronized promise through #recorder
|
|
1038
1040
|
*/
|
|
1039
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
1041
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
1040
1042
|
/**
|
|
1041
1043
|
* Selects an option in a drop-down select.
|
|
1042
1044
|
* Field is searched by label | name | CSS | XPath.
|
|
@@ -1063,7 +1065,7 @@ declare namespace CodeceptJS {
|
|
|
1063
1065
|
*
|
|
1064
1066
|
* Supported only for web testing
|
|
1065
1067
|
*/
|
|
1066
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
1068
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
1067
1069
|
/**
|
|
1068
1070
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
1069
1071
|
* Element can be located by CSS or XPath.
|
|
@@ -1076,7 +1078,7 @@ declare namespace CodeceptJS {
|
|
|
1076
1078
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
1077
1079
|
* @returns automatically synchronized promise through #recorder
|
|
1078
1080
|
*/
|
|
1079
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
1081
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
1080
1082
|
/**
|
|
1081
1083
|
* Waits for an element to become visible on a page (by default waits for 1sec).
|
|
1082
1084
|
* Element can be located by CSS or XPath.
|
|
@@ -1088,7 +1090,7 @@ declare namespace CodeceptJS {
|
|
|
1088
1090
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
1089
1091
|
* @returns automatically synchronized promise through #recorder
|
|
1090
1092
|
*/
|
|
1091
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
1093
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
1092
1094
|
/**
|
|
1093
1095
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
1094
1096
|
* Element can be located by CSS or XPath.
|
|
@@ -1100,7 +1102,7 @@ declare namespace CodeceptJS {
|
|
|
1100
1102
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
1101
1103
|
* @returns automatically synchronized promise through #recorder
|
|
1102
1104
|
*/
|
|
1103
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
1105
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
1104
1106
|
/**
|
|
1105
1107
|
* Waits for a text to appear (by default waits for 1sec).
|
|
1106
1108
|
* Element can be located by CSS or XPath.
|
|
@@ -1115,7 +1117,7 @@ declare namespace CodeceptJS {
|
|
|
1115
1117
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
1116
1118
|
* @returns automatically synchronized promise through #recorder
|
|
1117
1119
|
*/
|
|
1118
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
1120
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
1119
1121
|
}
|
|
1120
1122
|
/**
|
|
1121
1123
|
* This helper allows performing assertions based on Chai.
|
|
@@ -1842,7 +1844,7 @@ declare namespace CodeceptJS {
|
|
|
1842
1844
|
* @param headers - list of request headers can be passed
|
|
1843
1845
|
* @returns automatically synchronized promise through #recorder
|
|
1844
1846
|
*/
|
|
1845
|
-
amOnPage(url: string, headers: any):
|
|
1847
|
+
amOnPage(url: string, headers: any): void;
|
|
1846
1848
|
/**
|
|
1847
1849
|
* Checks that title contains text.
|
|
1848
1850
|
*
|
|
@@ -1852,7 +1854,7 @@ declare namespace CodeceptJS {
|
|
|
1852
1854
|
* @param text - text value to check.
|
|
1853
1855
|
* @returns automatically synchronized promise through #recorder
|
|
1854
1856
|
*/
|
|
1855
|
-
seeInTitle(text: string):
|
|
1857
|
+
seeInTitle(text: string): void;
|
|
1856
1858
|
/**
|
|
1857
1859
|
* Checks that title does not contain text.
|
|
1858
1860
|
*
|
|
@@ -1862,7 +1864,7 @@ declare namespace CodeceptJS {
|
|
|
1862
1864
|
* @param text - value to check.
|
|
1863
1865
|
* @returns automatically synchronized promise through #recorder
|
|
1864
1866
|
*/
|
|
1865
|
-
dontSeeInTitle(text: string):
|
|
1867
|
+
dontSeeInTitle(text: string): void;
|
|
1866
1868
|
/**
|
|
1867
1869
|
* Retrieves a page title and returns it to test.
|
|
1868
1870
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -1893,13 +1895,13 @@ declare namespace CodeceptJS {
|
|
|
1893
1895
|
* @param url - a fragment to check
|
|
1894
1896
|
* @returns automatically synchronized promise through #recorder
|
|
1895
1897
|
*/
|
|
1896
|
-
seeInCurrentUrl(url: string):
|
|
1898
|
+
seeInCurrentUrl(url: string): void;
|
|
1897
1899
|
/**
|
|
1898
1900
|
* Checks that current url does not contain a provided fragment.
|
|
1899
1901
|
* @param url - value to check.
|
|
1900
1902
|
* @returns automatically synchronized promise through #recorder
|
|
1901
1903
|
*/
|
|
1902
|
-
dontSeeInCurrentUrl(url: string):
|
|
1904
|
+
dontSeeInCurrentUrl(url: string): void;
|
|
1903
1905
|
/**
|
|
1904
1906
|
* Checks that current url is equal to provided one.
|
|
1905
1907
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -1912,7 +1914,7 @@ declare namespace CodeceptJS {
|
|
|
1912
1914
|
* @param url - value to check.
|
|
1913
1915
|
* @returns automatically synchronized promise through #recorder
|
|
1914
1916
|
*/
|
|
1915
|
-
seeCurrentUrlEquals(url: string):
|
|
1917
|
+
seeCurrentUrlEquals(url: string): void;
|
|
1916
1918
|
/**
|
|
1917
1919
|
* Checks that current url is not equal to provided one.
|
|
1918
1920
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -1924,7 +1926,7 @@ declare namespace CodeceptJS {
|
|
|
1924
1926
|
* @param url - value to check.
|
|
1925
1927
|
* @returns automatically synchronized promise through #recorder
|
|
1926
1928
|
*/
|
|
1927
|
-
dontSeeCurrentUrlEquals(url: string):
|
|
1929
|
+
dontSeeCurrentUrlEquals(url: string): void;
|
|
1928
1930
|
/**
|
|
1929
1931
|
* Checks that a page contains a visible text.
|
|
1930
1932
|
* Use context parameter to narrow down the search.
|
|
@@ -1938,7 +1940,7 @@ declare namespace CodeceptJS {
|
|
|
1938
1940
|
* @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
1939
1941
|
* @returns automatically synchronized promise through #recorder
|
|
1940
1942
|
*/
|
|
1941
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
1943
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
1942
1944
|
/**
|
|
1943
1945
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
1944
1946
|
* Use context parameter to narrow down the search.
|
|
@@ -1951,7 +1953,7 @@ declare namespace CodeceptJS {
|
|
|
1951
1953
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
1952
1954
|
* @returns automatically synchronized promise through #recorder
|
|
1953
1955
|
*/
|
|
1954
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
1956
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
1955
1957
|
/**
|
|
1956
1958
|
* Checks that a given Element is visible
|
|
1957
1959
|
* Element is located by CSS or XPath.
|
|
@@ -1962,7 +1964,7 @@ declare namespace CodeceptJS {
|
|
|
1962
1964
|
* @param locator - located by CSS|XPath|strict locator.
|
|
1963
1965
|
* @returns automatically synchronized promise through #recorder
|
|
1964
1966
|
*/
|
|
1965
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
1967
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
1966
1968
|
/**
|
|
1967
1969
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
1968
1970
|
*
|
|
@@ -1972,7 +1974,7 @@ declare namespace CodeceptJS {
|
|
|
1972
1974
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
1973
1975
|
* @returns automatically synchronized promise through #recorder
|
|
1974
1976
|
*/
|
|
1975
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
1977
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
1976
1978
|
/**
|
|
1977
1979
|
* Checks that a given Element is present in the DOM
|
|
1978
1980
|
* Element is located by CSS or XPath.
|
|
@@ -1983,7 +1985,7 @@ declare namespace CodeceptJS {
|
|
|
1983
1985
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
1984
1986
|
* @returns automatically synchronized promise through #recorder
|
|
1985
1987
|
*/
|
|
1986
|
-
seeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
1988
|
+
seeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
1987
1989
|
/**
|
|
1988
1990
|
* Opposite to `seeElementInDOM`. Checks that element is not on page.
|
|
1989
1991
|
*
|
|
@@ -1993,7 +1995,7 @@ declare namespace CodeceptJS {
|
|
|
1993
1995
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
1994
1996
|
* @returns automatically synchronized promise through #recorder
|
|
1995
1997
|
*/
|
|
1996
|
-
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
1998
|
+
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
1997
1999
|
/**
|
|
1998
2000
|
* Checks that the current page contains the given string in its raw source code.
|
|
1999
2001
|
*
|
|
@@ -2003,7 +2005,7 @@ declare namespace CodeceptJS {
|
|
|
2003
2005
|
* @param text - value to check.
|
|
2004
2006
|
* @returns automatically synchronized promise through #recorder
|
|
2005
2007
|
*/
|
|
2006
|
-
seeInSource(text: string):
|
|
2008
|
+
seeInSource(text: string): void;
|
|
2007
2009
|
/**
|
|
2008
2010
|
* Checks that the current page does not contains the given string in its raw source code.
|
|
2009
2011
|
*
|
|
@@ -2013,7 +2015,7 @@ declare namespace CodeceptJS {
|
|
|
2013
2015
|
* @param value - to check.
|
|
2014
2016
|
* @returns automatically synchronized promise through #recorder
|
|
2015
2017
|
*/
|
|
2016
|
-
dontSeeInSource(value: string):
|
|
2018
|
+
dontSeeInSource(value: string): void;
|
|
2017
2019
|
/**
|
|
2018
2020
|
* Asserts that an element appears a given number of times in the DOM.
|
|
2019
2021
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -2026,7 +2028,7 @@ declare namespace CodeceptJS {
|
|
|
2026
2028
|
* @param num - number of elements.
|
|
2027
2029
|
* @returns automatically synchronized promise through #recorder
|
|
2028
2030
|
*/
|
|
2029
|
-
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
2031
|
+
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
2030
2032
|
/**
|
|
2031
2033
|
* Asserts that an element is visible a given number of times.
|
|
2032
2034
|
* Element is located by CSS or XPath.
|
|
@@ -2038,7 +2040,7 @@ declare namespace CodeceptJS {
|
|
|
2038
2040
|
* @param num - number of elements.
|
|
2039
2041
|
* @returns automatically synchronized promise through #recorder
|
|
2040
2042
|
*/
|
|
2041
|
-
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
2043
|
+
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
2042
2044
|
/**
|
|
2043
2045
|
* Grab number of visible elements by locator.
|
|
2044
2046
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -2076,7 +2078,7 @@ declare namespace CodeceptJS {
|
|
|
2076
2078
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
2077
2079
|
* @returns automatically synchronized promise through #recorder
|
|
2078
2080
|
*/
|
|
2079
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null):
|
|
2081
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
|
|
2080
2082
|
/**
|
|
2081
2083
|
* Performs a double-click on an element matched by link|button|label|CSS or XPath.
|
|
2082
2084
|
* Context can be specified as second parameter to narrow search.
|
|
@@ -2091,7 +2093,7 @@ declare namespace CodeceptJS {
|
|
|
2091
2093
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
2092
2094
|
* @returns automatically synchronized promise through #recorder
|
|
2093
2095
|
*/
|
|
2094
|
-
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
2096
|
+
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
2095
2097
|
/**
|
|
2096
2098
|
* Performs right click on a clickable element matched by semantic locator, CSS or XPath.
|
|
2097
2099
|
*
|
|
@@ -2107,7 +2109,7 @@ declare namespace CodeceptJS {
|
|
|
2107
2109
|
* @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
2108
2110
|
* @returns automatically synchronized promise through #recorder
|
|
2109
2111
|
*/
|
|
2110
|
-
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
2112
|
+
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
2111
2113
|
/**
|
|
2112
2114
|
* Moves cursor to element matched by locator.
|
|
2113
2115
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -2121,7 +2123,7 @@ declare namespace CodeceptJS {
|
|
|
2121
2123
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
2122
2124
|
* @returns automatically synchronized promise through #recorder
|
|
2123
2125
|
*/
|
|
2124
|
-
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
2126
|
+
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
2125
2127
|
/**
|
|
2126
2128
|
* Executes sync script on a page.
|
|
2127
2129
|
* Pass arguments to function as additional parameters.
|
|
@@ -2190,7 +2192,7 @@ declare namespace CodeceptJS {
|
|
|
2190
2192
|
* @param height - height in pixels.
|
|
2191
2193
|
* @returns automatically synchronized promise through #recorder
|
|
2192
2194
|
*/
|
|
2193
|
-
resizeWindow(width: number, height: number):
|
|
2195
|
+
resizeWindow(width: number, height: number): void;
|
|
2194
2196
|
/**
|
|
2195
2197
|
* Selects a checkbox or radio button.
|
|
2196
2198
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -2206,7 +2208,7 @@ declare namespace CodeceptJS {
|
|
|
2206
2208
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2207
2209
|
* @returns automatically synchronized promise through #recorder
|
|
2208
2210
|
*/
|
|
2209
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
2211
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
2210
2212
|
/**
|
|
2211
2213
|
* Unselects a checkbox or radio button.
|
|
2212
2214
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -2222,7 +2224,7 @@ declare namespace CodeceptJS {
|
|
|
2222
2224
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
2223
2225
|
* @returns automatically synchronized promise through #recorder
|
|
2224
2226
|
*/
|
|
2225
|
-
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
2227
|
+
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
2226
2228
|
/**
|
|
2227
2229
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
2228
2230
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -2241,7 +2243,7 @@ declare namespace CodeceptJS {
|
|
|
2241
2243
|
* @param value - text value to fill.
|
|
2242
2244
|
* @returns automatically synchronized promise through #recorder
|
|
2243
2245
|
*/
|
|
2244
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
2246
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
2245
2247
|
/**
|
|
2246
2248
|
* Clears a `<textarea>` or text `<input>` element's value.
|
|
2247
2249
|
*
|
|
@@ -2253,7 +2255,7 @@ declare namespace CodeceptJS {
|
|
|
2253
2255
|
* @param editable - field located by label|name|CSS|XPath|strict locator.
|
|
2254
2256
|
* @returns automatically synchronized promise through #recorder.
|
|
2255
2257
|
*/
|
|
2256
|
-
clearField(editable: LocatorOrString):
|
|
2258
|
+
clearField(editable: LocatorOrString): void;
|
|
2257
2259
|
/**
|
|
2258
2260
|
* Appends text to a input field or textarea.
|
|
2259
2261
|
* Field is located by name, label, CSS or XPath
|
|
@@ -2267,7 +2269,7 @@ declare namespace CodeceptJS {
|
|
|
2267
2269
|
* @param value - text value to append.
|
|
2268
2270
|
* @returns automatically synchronized promise through #recorder
|
|
2269
2271
|
*/
|
|
2270
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
2272
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
2271
2273
|
/**
|
|
2272
2274
|
* Checks that the given input field or textarea equals to given value.
|
|
2273
2275
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -2282,7 +2284,7 @@ declare namespace CodeceptJS {
|
|
|
2282
2284
|
* @param value - value to check.
|
|
2283
2285
|
* @returns automatically synchronized promise through #recorder
|
|
2284
2286
|
*/
|
|
2285
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
2287
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
2286
2288
|
/**
|
|
2287
2289
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
2288
2290
|
* Opposite to `seeInField`.
|
|
@@ -2295,7 +2297,7 @@ declare namespace CodeceptJS {
|
|
|
2295
2297
|
* @param value - value to check.
|
|
2296
2298
|
* @returns automatically synchronized promise through #recorder
|
|
2297
2299
|
*/
|
|
2298
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
2300
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
2299
2301
|
/**
|
|
2300
2302
|
* Sends [input event](http://electron.atom.io/docs/api/web-contents/#webcontentssendinputeventevent) on a page.
|
|
2301
2303
|
* Can submit special keys like 'Enter', 'Backspace', etc
|
|
@@ -2323,7 +2325,7 @@ declare namespace CodeceptJS {
|
|
|
2323
2325
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
2324
2326
|
* @returns automatically synchronized promise through #recorder
|
|
2325
2327
|
*/
|
|
2326
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
2328
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
2327
2329
|
/**
|
|
2328
2330
|
* Verifies that the specified checkbox is not checked.
|
|
2329
2331
|
*
|
|
@@ -2335,7 +2337,7 @@ declare namespace CodeceptJS {
|
|
|
2335
2337
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
2336
2338
|
* @returns automatically synchronized promise through #recorder
|
|
2337
2339
|
*/
|
|
2338
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
2340
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
2339
2341
|
/**
|
|
2340
2342
|
* Attaches a file to element located by label, name, CSS or XPath
|
|
2341
2343
|
* Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
@@ -2352,7 +2354,7 @@ declare namespace CodeceptJS {
|
|
|
2352
2354
|
*
|
|
2353
2355
|
* 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))
|
|
2354
2356
|
*/
|
|
2355
|
-
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string):
|
|
2357
|
+
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
|
|
2356
2358
|
/**
|
|
2357
2359
|
* Retrieves all texts from an element located by CSS or XPath and returns it to test.
|
|
2358
2360
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -2483,7 +2485,7 @@ declare namespace CodeceptJS {
|
|
|
2483
2485
|
* @param option - visible text or value of option.
|
|
2484
2486
|
* @returns automatically synchronized promise through #recorder
|
|
2485
2487
|
*/
|
|
2486
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
2488
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
2487
2489
|
/**
|
|
2488
2490
|
* Sets cookie(s).
|
|
2489
2491
|
*
|
|
@@ -2505,7 +2507,7 @@ declare namespace CodeceptJS {
|
|
|
2505
2507
|
* Wrapper for `.cookies.set(cookie)`.
|
|
2506
2508
|
* [See more](https://github.com/segmentio/nightmare/blob/master/Readme.md#cookiessetcookie)
|
|
2507
2509
|
*/
|
|
2508
|
-
setCookie(cookie: Cookie | Cookie[]):
|
|
2510
|
+
setCookie(cookie: Cookie | Cookie[]): void;
|
|
2509
2511
|
/**
|
|
2510
2512
|
* Checks that cookie with given name exists.
|
|
2511
2513
|
*
|
|
@@ -2515,7 +2517,7 @@ declare namespace CodeceptJS {
|
|
|
2515
2517
|
* @param name - cookie name.
|
|
2516
2518
|
* @returns automatically synchronized promise through #recorder
|
|
2517
2519
|
*/
|
|
2518
|
-
seeCookie(name: string):
|
|
2520
|
+
seeCookie(name: string): void;
|
|
2519
2521
|
/**
|
|
2520
2522
|
* Checks that cookie with given name does not exist.
|
|
2521
2523
|
*
|
|
@@ -2525,7 +2527,7 @@ declare namespace CodeceptJS {
|
|
|
2525
2527
|
* @param name - cookie name.
|
|
2526
2528
|
* @returns automatically synchronized promise through #recorder
|
|
2527
2529
|
*/
|
|
2528
|
-
dontSeeCookie(name: string):
|
|
2530
|
+
dontSeeCookie(name: string): void;
|
|
2529
2531
|
/**
|
|
2530
2532
|
* Gets a cookie object by name.
|
|
2531
2533
|
* If none provided gets all cookies.
|
|
@@ -2550,12 +2552,11 @@ declare namespace CodeceptJS {
|
|
|
2550
2552
|
*
|
|
2551
2553
|
* ```js
|
|
2552
2554
|
* I.clearCookie();
|
|
2553
|
-
* I.clearCookie('test');
|
|
2555
|
+
* I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
|
|
2554
2556
|
* ```
|
|
2555
2557
|
* @param [cookie = null] - (optional, `null` by default) cookie name
|
|
2556
|
-
* @returns automatically synchronized promise through #recorder
|
|
2557
2558
|
*/
|
|
2558
|
-
clearCookie(cookie?: string):
|
|
2559
|
+
clearCookie(cookie?: string): void;
|
|
2559
2560
|
/**
|
|
2560
2561
|
* Waits for a function to return true (waits for 1 sec by default).
|
|
2561
2562
|
* Running in browser context.
|
|
@@ -2574,7 +2575,7 @@ declare namespace CodeceptJS {
|
|
|
2574
2575
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
2575
2576
|
* @returns automatically synchronized promise through #recorder
|
|
2576
2577
|
*/
|
|
2577
|
-
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number):
|
|
2578
|
+
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
|
|
2578
2579
|
/**
|
|
2579
2580
|
* Pauses execution for a number of seconds.
|
|
2580
2581
|
*
|
|
@@ -2584,7 +2585,7 @@ declare namespace CodeceptJS {
|
|
|
2584
2585
|
* @param sec - number of second to wait.
|
|
2585
2586
|
* @returns automatically synchronized promise through #recorder
|
|
2586
2587
|
*/
|
|
2587
|
-
wait(sec: number):
|
|
2588
|
+
wait(sec: number): void;
|
|
2588
2589
|
/**
|
|
2589
2590
|
* Waits for a text to appear (by default waits for 1sec).
|
|
2590
2591
|
* Element can be located by CSS or XPath.
|
|
@@ -2599,7 +2600,7 @@ declare namespace CodeceptJS {
|
|
|
2599
2600
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
2600
2601
|
* @returns automatically synchronized promise through #recorder
|
|
2601
2602
|
*/
|
|
2602
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
2603
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
2603
2604
|
/**
|
|
2604
2605
|
* Waits for an element to become visible on a page (by default waits for 1sec).
|
|
2605
2606
|
* Element can be located by CSS or XPath.
|
|
@@ -2611,7 +2612,7 @@ declare namespace CodeceptJS {
|
|
|
2611
2612
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
2612
2613
|
* @returns automatically synchronized promise through #recorder
|
|
2613
2614
|
*/
|
|
2614
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
2615
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
2615
2616
|
/**
|
|
2616
2617
|
* Waits for an element to hide (by default waits for 1sec).
|
|
2617
2618
|
* Element can be located by CSS or XPath.
|
|
@@ -2623,7 +2624,7 @@ declare namespace CodeceptJS {
|
|
|
2623
2624
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
2624
2625
|
* @returns automatically synchronized promise through #recorder
|
|
2625
2626
|
*/
|
|
2626
|
-
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
2627
|
+
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
2627
2628
|
/**
|
|
2628
2629
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
2629
2630
|
* Element can be located by CSS or XPath.
|
|
@@ -2635,7 +2636,7 @@ declare namespace CodeceptJS {
|
|
|
2635
2636
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
2636
2637
|
* @returns automatically synchronized promise through #recorder
|
|
2637
2638
|
*/
|
|
2638
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
2639
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
2639
2640
|
/**
|
|
2640
2641
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
2641
2642
|
* Element can be located by CSS or XPath.
|
|
@@ -2648,7 +2649,7 @@ declare namespace CodeceptJS {
|
|
|
2648
2649
|
* @param [sec] - (optional, `1` by default) time in seconds to wait
|
|
2649
2650
|
* @returns automatically synchronized promise through #recorder
|
|
2650
2651
|
*/
|
|
2651
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
2652
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
2652
2653
|
/**
|
|
2653
2654
|
* Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
|
|
2654
2655
|
* Element can be located by CSS or XPath.
|
|
@@ -2660,7 +2661,7 @@ declare namespace CodeceptJS {
|
|
|
2660
2661
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
2661
2662
|
* @returns automatically synchronized promise through #recorder
|
|
2662
2663
|
*/
|
|
2663
|
-
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
2664
|
+
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
2664
2665
|
/**
|
|
2665
2666
|
* Reload the current page.
|
|
2666
2667
|
*
|
|
@@ -2669,7 +2670,7 @@ declare namespace CodeceptJS {
|
|
|
2669
2670
|
* ```
|
|
2670
2671
|
* @returns automatically synchronized promise through #recorder
|
|
2671
2672
|
*/
|
|
2672
|
-
refreshPage():
|
|
2673
|
+
refreshPage(): void;
|
|
2673
2674
|
/**
|
|
2674
2675
|
* Reload the page
|
|
2675
2676
|
*/
|
|
@@ -2685,7 +2686,7 @@ declare namespace CodeceptJS {
|
|
|
2685
2686
|
* @param fileName - file name to save.
|
|
2686
2687
|
* @returns automatically synchronized promise through #recorder
|
|
2687
2688
|
*/
|
|
2688
|
-
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string):
|
|
2689
|
+
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): void;
|
|
2689
2690
|
/**
|
|
2690
2691
|
* Grab the width, height, location of given locator.
|
|
2691
2692
|
* Provide `width` or `height`as second param to get your desired prop.
|
|
@@ -2722,7 +2723,7 @@ declare namespace CodeceptJS {
|
|
|
2722
2723
|
* @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
2723
2724
|
* @returns automatically synchronized promise through #recorder
|
|
2724
2725
|
*/
|
|
2725
|
-
saveScreenshot(fileName: string, fullPage?: boolean):
|
|
2726
|
+
saveScreenshot(fileName: string, fullPage?: boolean): void;
|
|
2726
2727
|
/**
|
|
2727
2728
|
* Scrolls to element matched by locator.
|
|
2728
2729
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -2736,7 +2737,7 @@ declare namespace CodeceptJS {
|
|
|
2736
2737
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
2737
2738
|
* @returns automatically synchronized promise through #recorder
|
|
2738
2739
|
*/
|
|
2739
|
-
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
2740
|
+
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
2740
2741
|
/**
|
|
2741
2742
|
* Scroll page to the top.
|
|
2742
2743
|
*
|
|
@@ -2745,7 +2746,7 @@ declare namespace CodeceptJS {
|
|
|
2745
2746
|
* ```
|
|
2746
2747
|
* @returns automatically synchronized promise through #recorder
|
|
2747
2748
|
*/
|
|
2748
|
-
scrollPageToTop():
|
|
2749
|
+
scrollPageToTop(): void;
|
|
2749
2750
|
/**
|
|
2750
2751
|
* Scroll page to the bottom.
|
|
2751
2752
|
*
|
|
@@ -2754,7 +2755,7 @@ declare namespace CodeceptJS {
|
|
|
2754
2755
|
* ```
|
|
2755
2756
|
* @returns automatically synchronized promise through #recorder
|
|
2756
2757
|
*/
|
|
2757
|
-
scrollPageToBottom():
|
|
2758
|
+
scrollPageToBottom(): void;
|
|
2758
2759
|
/**
|
|
2759
2760
|
* Retrieves a page scroll position and returns it to test.
|
|
2760
2761
|
* Resumes test execution, so **should be used inside an async function with `await`** operator.
|
|
@@ -3147,7 +3148,7 @@ declare namespace CodeceptJS {
|
|
|
3147
3148
|
* @param text - value to check.
|
|
3148
3149
|
* @returns automatically synchronized promise through #recorder
|
|
3149
3150
|
*/
|
|
3150
|
-
seeInPopup(text: string):
|
|
3151
|
+
seeInPopup(text: string): void;
|
|
3151
3152
|
/**
|
|
3152
3153
|
* Set current page
|
|
3153
3154
|
* @param page - page to set
|
|
@@ -3187,7 +3188,7 @@ declare namespace CodeceptJS {
|
|
|
3187
3188
|
* @param url - url path or global url.
|
|
3188
3189
|
* @returns automatically synchronized promise through #recorder
|
|
3189
3190
|
*/
|
|
3190
|
-
amOnPage(url: string):
|
|
3191
|
+
amOnPage(url: string): void;
|
|
3191
3192
|
/**
|
|
3192
3193
|
* Resize the current window to provided width and height.
|
|
3193
3194
|
* First parameter can be set to `maximize`.
|
|
@@ -3208,7 +3209,7 @@ declare namespace CodeceptJS {
|
|
|
3208
3209
|
* { setWindowSize } = require('@codeceptjs/configure');
|
|
3209
3210
|
* ````
|
|
3210
3211
|
*/
|
|
3211
|
-
resizeWindow(width: number, height: number):
|
|
3212
|
+
resizeWindow(width: number, height: number): void;
|
|
3212
3213
|
/**
|
|
3213
3214
|
* Set headers for all next requests
|
|
3214
3215
|
*
|
|
@@ -3233,7 +3234,7 @@ declare namespace CodeceptJS {
|
|
|
3233
3234
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
3234
3235
|
* @returns automatically synchronized promise through #recorder
|
|
3235
3236
|
*/
|
|
3236
|
-
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
3237
|
+
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
3237
3238
|
/**
|
|
3238
3239
|
* Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
|
|
3239
3240
|
*
|
|
@@ -3248,7 +3249,7 @@ declare namespace CodeceptJS {
|
|
|
3248
3249
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
|
|
3249
3250
|
* @returns automatically synchronized promise through #recorder
|
|
3250
3251
|
*/
|
|
3251
|
-
focus(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
3252
|
+
focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
3252
3253
|
/**
|
|
3253
3254
|
* Remove focus from a text input, button, etc.
|
|
3254
3255
|
* Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
|
|
@@ -3268,7 +3269,7 @@ declare namespace CodeceptJS {
|
|
|
3268
3269
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
|
|
3269
3270
|
* @returns automatically synchronized promise through #recorder
|
|
3270
3271
|
*/
|
|
3271
|
-
blur(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
3272
|
+
blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
3272
3273
|
/**
|
|
3273
3274
|
* Return the checked status of given element.
|
|
3274
3275
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
@@ -3299,7 +3300,7 @@ declare namespace CodeceptJS {
|
|
|
3299
3300
|
* > 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`
|
|
3300
3301
|
* @returns automatically synchronized promise through #recorder
|
|
3301
3302
|
*/
|
|
3302
|
-
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any):
|
|
3303
|
+
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString, options?: any): void;
|
|
3303
3304
|
/**
|
|
3304
3305
|
* Restart browser with a new context and a new page
|
|
3305
3306
|
*
|
|
@@ -3322,7 +3323,7 @@ declare namespace CodeceptJS {
|
|
|
3322
3323
|
* ```
|
|
3323
3324
|
* @returns automatically synchronized promise through #recorder
|
|
3324
3325
|
*/
|
|
3325
|
-
refreshPage():
|
|
3326
|
+
refreshPage(): void;
|
|
3326
3327
|
/**
|
|
3327
3328
|
* Scroll page to the top.
|
|
3328
3329
|
*
|
|
@@ -3331,7 +3332,7 @@ declare namespace CodeceptJS {
|
|
|
3331
3332
|
* ```
|
|
3332
3333
|
* @returns automatically synchronized promise through #recorder
|
|
3333
3334
|
*/
|
|
3334
|
-
scrollPageToTop():
|
|
3335
|
+
scrollPageToTop(): void;
|
|
3335
3336
|
/**
|
|
3336
3337
|
* Scroll page to the bottom.
|
|
3337
3338
|
*
|
|
@@ -3340,7 +3341,7 @@ declare namespace CodeceptJS {
|
|
|
3340
3341
|
* ```
|
|
3341
3342
|
* @returns automatically synchronized promise through #recorder
|
|
3342
3343
|
*/
|
|
3343
|
-
scrollPageToBottom():
|
|
3344
|
+
scrollPageToBottom(): void;
|
|
3344
3345
|
/**
|
|
3345
3346
|
* Scrolls to element matched by locator.
|
|
3346
3347
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -3354,7 +3355,7 @@ declare namespace CodeceptJS {
|
|
|
3354
3355
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
3355
3356
|
* @returns automatically synchronized promise through #recorder
|
|
3356
3357
|
*/
|
|
3357
|
-
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
3358
|
+
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
3358
3359
|
/**
|
|
3359
3360
|
* Checks that title contains text.
|
|
3360
3361
|
*
|
|
@@ -3364,7 +3365,7 @@ declare namespace CodeceptJS {
|
|
|
3364
3365
|
* @param text - text value to check.
|
|
3365
3366
|
* @returns automatically synchronized promise through #recorder
|
|
3366
3367
|
*/
|
|
3367
|
-
seeInTitle(text: string):
|
|
3368
|
+
seeInTitle(text: string): void;
|
|
3368
3369
|
/**
|
|
3369
3370
|
* Retrieves a page scroll position and returns it to test.
|
|
3370
3371
|
* Resumes test execution, so **should be used inside an async function with `await`** operator.
|
|
@@ -3384,7 +3385,7 @@ declare namespace CodeceptJS {
|
|
|
3384
3385
|
* @param text - value to check.
|
|
3385
3386
|
* @returns automatically synchronized promise through #recorder
|
|
3386
3387
|
*/
|
|
3387
|
-
seeTitleEquals(text: string):
|
|
3388
|
+
seeTitleEquals(text: string): void;
|
|
3388
3389
|
/**
|
|
3389
3390
|
* Checks that title does not contain text.
|
|
3390
3391
|
*
|
|
@@ -3394,7 +3395,7 @@ declare namespace CodeceptJS {
|
|
|
3394
3395
|
* @param text - value to check.
|
|
3395
3396
|
* @returns automatically synchronized promise through #recorder
|
|
3396
3397
|
*/
|
|
3397
|
-
dontSeeInTitle(text: string):
|
|
3398
|
+
dontSeeInTitle(text: string): void;
|
|
3398
3399
|
/**
|
|
3399
3400
|
* Retrieves a page title and returns it to test.
|
|
3400
3401
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -3517,7 +3518,7 @@ declare namespace CodeceptJS {
|
|
|
3517
3518
|
* @param locator - located by CSS|XPath|strict locator.
|
|
3518
3519
|
* @returns automatically synchronized promise through #recorder
|
|
3519
3520
|
*/
|
|
3520
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
3521
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
3521
3522
|
/**
|
|
3522
3523
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
3523
3524
|
*
|
|
@@ -3527,7 +3528,7 @@ declare namespace CodeceptJS {
|
|
|
3527
3528
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
3528
3529
|
* @returns automatically synchronized promise through #recorder
|
|
3529
3530
|
*/
|
|
3530
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
3531
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
3531
3532
|
/**
|
|
3532
3533
|
* Checks that a given Element is present in the DOM
|
|
3533
3534
|
* Element is located by CSS or XPath.
|
|
@@ -3538,7 +3539,7 @@ declare namespace CodeceptJS {
|
|
|
3538
3539
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
3539
3540
|
* @returns automatically synchronized promise through #recorder
|
|
3540
3541
|
*/
|
|
3541
|
-
seeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
3542
|
+
seeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
3542
3543
|
/**
|
|
3543
3544
|
* Opposite to `seeElementInDOM`. Checks that element is not on page.
|
|
3544
3545
|
*
|
|
@@ -3548,7 +3549,7 @@ declare namespace CodeceptJS {
|
|
|
3548
3549
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
3549
3550
|
* @returns automatically synchronized promise through #recorder
|
|
3550
3551
|
*/
|
|
3551
|
-
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
3552
|
+
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
3552
3553
|
/**
|
|
3553
3554
|
* Handles a file download. A file name is required to save the file on disk.
|
|
3554
3555
|
* Files are saved to "output" directory.
|
|
@@ -3602,7 +3603,7 @@ declare namespace CodeceptJS {
|
|
|
3602
3603
|
* ```
|
|
3603
3604
|
* @returns automatically synchronized promise through #recorder
|
|
3604
3605
|
*/
|
|
3605
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any):
|
|
3606
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null, options?: any): void;
|
|
3606
3607
|
/**
|
|
3607
3608
|
* Clicks link and waits for navigation (deprecated)
|
|
3608
3609
|
*/
|
|
@@ -3636,7 +3637,7 @@ declare namespace CodeceptJS {
|
|
|
3636
3637
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
3637
3638
|
* @returns automatically synchronized promise through #recorder
|
|
3638
3639
|
*/
|
|
3639
|
-
forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
3640
|
+
forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
3640
3641
|
/**
|
|
3641
3642
|
* Performs a double-click on an element matched by link|button|label|CSS or XPath.
|
|
3642
3643
|
* Context can be specified as second parameter to narrow search.
|
|
@@ -3651,7 +3652,7 @@ declare namespace CodeceptJS {
|
|
|
3651
3652
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
3652
3653
|
* @returns automatically synchronized promise through #recorder
|
|
3653
3654
|
*/
|
|
3654
|
-
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
3655
|
+
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
3655
3656
|
/**
|
|
3656
3657
|
* Performs right click on a clickable element matched by semantic locator, CSS or XPath.
|
|
3657
3658
|
*
|
|
@@ -3667,7 +3668,7 @@ declare namespace CodeceptJS {
|
|
|
3667
3668
|
* @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
3668
3669
|
* @returns automatically synchronized promise through #recorder
|
|
3669
3670
|
*/
|
|
3670
|
-
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
3671
|
+
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
3671
3672
|
/**
|
|
3672
3673
|
* Selects a checkbox or radio button.
|
|
3673
3674
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -3694,7 +3695,7 @@ declare namespace CodeceptJS {
|
|
|
3694
3695
|
* ```
|
|
3695
3696
|
* > ⚠️ To avoid flakiness, option `force: true` is set by default
|
|
3696
3697
|
*/
|
|
3697
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
3698
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
3698
3699
|
/**
|
|
3699
3700
|
* Unselects a checkbox or radio button.
|
|
3700
3701
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -3721,7 +3722,7 @@ declare namespace CodeceptJS {
|
|
|
3721
3722
|
* ```
|
|
3722
3723
|
* > ⚠️ To avoid flakiness, option `force: true` is set by default
|
|
3723
3724
|
*/
|
|
3724
|
-
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
3725
|
+
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
3725
3726
|
/**
|
|
3726
3727
|
* Verifies that the specified checkbox is checked.
|
|
3727
3728
|
*
|
|
@@ -3733,7 +3734,7 @@ declare namespace CodeceptJS {
|
|
|
3733
3734
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
3734
3735
|
* @returns automatically synchronized promise through #recorder
|
|
3735
3736
|
*/
|
|
3736
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
3737
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
3737
3738
|
/**
|
|
3738
3739
|
* Verifies that the specified checkbox is not checked.
|
|
3739
3740
|
*
|
|
@@ -3745,7 +3746,7 @@ declare namespace CodeceptJS {
|
|
|
3745
3746
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
3746
3747
|
* @returns automatically synchronized promise through #recorder
|
|
3747
3748
|
*/
|
|
3748
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
3749
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
3749
3750
|
/**
|
|
3750
3751
|
* Presses a key in the browser and leaves it in a down state.
|
|
3751
3752
|
*
|
|
@@ -3759,7 +3760,7 @@ declare namespace CodeceptJS {
|
|
|
3759
3760
|
* @param key - name of key to press down.
|
|
3760
3761
|
* @returns automatically synchronized promise through #recorder
|
|
3761
3762
|
*/
|
|
3762
|
-
pressKeyDown(key: string):
|
|
3763
|
+
pressKeyDown(key: string): void;
|
|
3763
3764
|
/**
|
|
3764
3765
|
* Releases a key in the browser which was previously set to a down state.
|
|
3765
3766
|
*
|
|
@@ -3773,7 +3774,7 @@ declare namespace CodeceptJS {
|
|
|
3773
3774
|
* @param key - name of key to release.
|
|
3774
3775
|
* @returns automatically synchronized promise through #recorder
|
|
3775
3776
|
*/
|
|
3776
|
-
pressKeyUp(key: string):
|
|
3777
|
+
pressKeyUp(key: string): void;
|
|
3777
3778
|
/**
|
|
3778
3779
|
* Presses a key in the browser (on a focused element).
|
|
3779
3780
|
*
|
|
@@ -3838,7 +3839,7 @@ declare namespace CodeceptJS {
|
|
|
3838
3839
|
*
|
|
3839
3840
|
* _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
|
|
3840
3841
|
*/
|
|
3841
|
-
pressKey(key: string | string[]):
|
|
3842
|
+
pressKey(key: string | string[]): void;
|
|
3842
3843
|
/**
|
|
3843
3844
|
* Types out the given text into an active field.
|
|
3844
3845
|
* To slow down typing use a second parameter, to set interval between key presses.
|
|
@@ -3861,7 +3862,7 @@ declare namespace CodeceptJS {
|
|
|
3861
3862
|
* @param [delay = null] - (optional) delay in ms between key presses
|
|
3862
3863
|
* @returns automatically synchronized promise through #recorder
|
|
3863
3864
|
*/
|
|
3864
|
-
type(key: string | string[], delay?: number):
|
|
3865
|
+
type(key: string | string[], delay?: number): void;
|
|
3865
3866
|
/**
|
|
3866
3867
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
3867
3868
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -3880,7 +3881,7 @@ declare namespace CodeceptJS {
|
|
|
3880
3881
|
* @param value - text value to fill.
|
|
3881
3882
|
* @returns automatically synchronized promise through #recorder
|
|
3882
3883
|
*/
|
|
3883
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
3884
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
3884
3885
|
/**
|
|
3885
3886
|
* Clears the text input element: `<input>`, `<textarea>` or `[contenteditable]` .
|
|
3886
3887
|
*
|
|
@@ -3911,7 +3912,7 @@ declare namespace CodeceptJS {
|
|
|
3911
3912
|
* @param value - text value to append.
|
|
3912
3913
|
* @returns automatically synchronized promise through #recorder
|
|
3913
3914
|
*/
|
|
3914
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
3915
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
3915
3916
|
/**
|
|
3916
3917
|
* Checks that the given input field or textarea equals to given value.
|
|
3917
3918
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -3926,7 +3927,7 @@ declare namespace CodeceptJS {
|
|
|
3926
3927
|
* @param value - value to check.
|
|
3927
3928
|
* @returns automatically synchronized promise through #recorder
|
|
3928
3929
|
*/
|
|
3929
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
3930
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
3930
3931
|
/**
|
|
3931
3932
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
3932
3933
|
* Opposite to `seeInField`.
|
|
@@ -3939,7 +3940,7 @@ declare namespace CodeceptJS {
|
|
|
3939
3940
|
* @param value - value to check.
|
|
3940
3941
|
* @returns automatically synchronized promise through #recorder
|
|
3941
3942
|
*/
|
|
3942
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
3943
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
3943
3944
|
/**
|
|
3944
3945
|
* Attaches a file to element located by label, name, CSS or XPath
|
|
3945
3946
|
* Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
@@ -3953,7 +3954,7 @@ declare namespace CodeceptJS {
|
|
|
3953
3954
|
* @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
|
|
3954
3955
|
* @returns automatically synchronized promise through #recorder
|
|
3955
3956
|
*/
|
|
3956
|
-
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string):
|
|
3957
|
+
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
|
|
3957
3958
|
/**
|
|
3958
3959
|
* Selects an option in a drop-down select.
|
|
3959
3960
|
* Field is searched by label | name | CSS | XPath.
|
|
@@ -3977,7 +3978,7 @@ declare namespace CodeceptJS {
|
|
|
3977
3978
|
* @param option - visible text or value of option.
|
|
3978
3979
|
* @returns automatically synchronized promise through #recorder
|
|
3979
3980
|
*/
|
|
3980
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
3981
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
3981
3982
|
/**
|
|
3982
3983
|
* Grab number of visible elements by locator.
|
|
3983
3984
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -3998,13 +3999,13 @@ declare namespace CodeceptJS {
|
|
|
3998
3999
|
* @param url - a fragment to check
|
|
3999
4000
|
* @returns automatically synchronized promise through #recorder
|
|
4000
4001
|
*/
|
|
4001
|
-
seeInCurrentUrl(url: string):
|
|
4002
|
+
seeInCurrentUrl(url: string): void;
|
|
4002
4003
|
/**
|
|
4003
4004
|
* Checks that current url does not contain a provided fragment.
|
|
4004
4005
|
* @param url - value to check.
|
|
4005
4006
|
* @returns automatically synchronized promise through #recorder
|
|
4006
4007
|
*/
|
|
4007
|
-
dontSeeInCurrentUrl(url: string):
|
|
4008
|
+
dontSeeInCurrentUrl(url: string): void;
|
|
4008
4009
|
/**
|
|
4009
4010
|
* Checks that current url is equal to provided one.
|
|
4010
4011
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -4017,7 +4018,7 @@ declare namespace CodeceptJS {
|
|
|
4017
4018
|
* @param url - value to check.
|
|
4018
4019
|
* @returns automatically synchronized promise through #recorder
|
|
4019
4020
|
*/
|
|
4020
|
-
seeCurrentUrlEquals(url: string):
|
|
4021
|
+
seeCurrentUrlEquals(url: string): void;
|
|
4021
4022
|
/**
|
|
4022
4023
|
* Checks that current url is not equal to provided one.
|
|
4023
4024
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -4029,7 +4030,7 @@ declare namespace CodeceptJS {
|
|
|
4029
4030
|
* @param url - value to check.
|
|
4030
4031
|
* @returns automatically synchronized promise through #recorder
|
|
4031
4032
|
*/
|
|
4032
|
-
dontSeeCurrentUrlEquals(url: string):
|
|
4033
|
+
dontSeeCurrentUrlEquals(url: string): void;
|
|
4033
4034
|
/**
|
|
4034
4035
|
* Checks that a page contains a visible text.
|
|
4035
4036
|
* Use context parameter to narrow down the search.
|
|
@@ -4043,7 +4044,7 @@ declare namespace CodeceptJS {
|
|
|
4043
4044
|
* @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
4044
4045
|
* @returns automatically synchronized promise through #recorder
|
|
4045
4046
|
*/
|
|
4046
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
4047
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
4047
4048
|
/**
|
|
4048
4049
|
* Checks that text is equal to provided one.
|
|
4049
4050
|
*
|
|
@@ -4054,7 +4055,7 @@ declare namespace CodeceptJS {
|
|
|
4054
4055
|
* @param [context = null] - element located by CSS|XPath|strict locator.
|
|
4055
4056
|
* @returns automatically synchronized promise through #recorder
|
|
4056
4057
|
*/
|
|
4057
|
-
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString):
|
|
4058
|
+
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
4058
4059
|
/**
|
|
4059
4060
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
4060
4061
|
* Use context parameter to narrow down the search.
|
|
@@ -4067,7 +4068,7 @@ declare namespace CodeceptJS {
|
|
|
4067
4068
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
4068
4069
|
* @returns automatically synchronized promise through #recorder
|
|
4069
4070
|
*/
|
|
4070
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
4071
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
4071
4072
|
/**
|
|
4072
4073
|
* Retrieves page source and returns it to test.
|
|
4073
4074
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -4109,7 +4110,7 @@ declare namespace CodeceptJS {
|
|
|
4109
4110
|
* @param text - value to check.
|
|
4110
4111
|
* @returns automatically synchronized promise through #recorder
|
|
4111
4112
|
*/
|
|
4112
|
-
seeInSource(text: string):
|
|
4113
|
+
seeInSource(text: string): void;
|
|
4113
4114
|
/**
|
|
4114
4115
|
* Checks that the current page does not contains the given string in its raw source code.
|
|
4115
4116
|
*
|
|
@@ -4119,7 +4120,7 @@ declare namespace CodeceptJS {
|
|
|
4119
4120
|
* @param value - to check.
|
|
4120
4121
|
* @returns automatically synchronized promise through #recorder
|
|
4121
4122
|
*/
|
|
4122
|
-
dontSeeInSource(value: string):
|
|
4123
|
+
dontSeeInSource(value: string): void;
|
|
4123
4124
|
/**
|
|
4124
4125
|
* Asserts that an element appears a given number of times in the DOM.
|
|
4125
4126
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -4132,7 +4133,7 @@ declare namespace CodeceptJS {
|
|
|
4132
4133
|
* @param num - number of elements.
|
|
4133
4134
|
* @returns automatically synchronized promise through #recorder
|
|
4134
4135
|
*/
|
|
4135
|
-
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
4136
|
+
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
4136
4137
|
/**
|
|
4137
4138
|
* Asserts that an element is visible a given number of times.
|
|
4138
4139
|
* Element is located by CSS or XPath.
|
|
@@ -4144,7 +4145,7 @@ declare namespace CodeceptJS {
|
|
|
4144
4145
|
* @param num - number of elements.
|
|
4145
4146
|
* @returns automatically synchronized promise through #recorder
|
|
4146
4147
|
*/
|
|
4147
|
-
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
4148
|
+
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
4148
4149
|
/**
|
|
4149
4150
|
* Sets cookie(s).
|
|
4150
4151
|
*
|
|
@@ -4162,7 +4163,7 @@ declare namespace CodeceptJS {
|
|
|
4162
4163
|
* @param cookie - a cookie object or array of cookie objects.
|
|
4163
4164
|
* @returns automatically synchronized promise through #recorder
|
|
4164
4165
|
*/
|
|
4165
|
-
setCookie(cookie: Cookie | Cookie[]):
|
|
4166
|
+
setCookie(cookie: Cookie | Cookie[]): void;
|
|
4166
4167
|
/**
|
|
4167
4168
|
* Checks that cookie with given name exists.
|
|
4168
4169
|
*
|
|
@@ -4172,7 +4173,7 @@ declare namespace CodeceptJS {
|
|
|
4172
4173
|
* @param name - cookie name.
|
|
4173
4174
|
* @returns automatically synchronized promise through #recorder
|
|
4174
4175
|
*/
|
|
4175
|
-
seeCookie(name: string):
|
|
4176
|
+
seeCookie(name: string): void;
|
|
4176
4177
|
/**
|
|
4177
4178
|
* Checks that cookie with given name does not exist.
|
|
4178
4179
|
*
|
|
@@ -4182,7 +4183,7 @@ declare namespace CodeceptJS {
|
|
|
4182
4183
|
* @param name - cookie name.
|
|
4183
4184
|
* @returns automatically synchronized promise through #recorder
|
|
4184
4185
|
*/
|
|
4185
|
-
dontSeeCookie(name: string):
|
|
4186
|
+
dontSeeCookie(name: string): void;
|
|
4186
4187
|
/**
|
|
4187
4188
|
* Gets a cookie object by name.
|
|
4188
4189
|
* If none provided gets all cookies.
|
|
@@ -4205,12 +4206,11 @@ declare namespace CodeceptJS {
|
|
|
4205
4206
|
*
|
|
4206
4207
|
* ```js
|
|
4207
4208
|
* I.clearCookie();
|
|
4208
|
-
* I.clearCookie('test');
|
|
4209
|
+
* I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
|
|
4209
4210
|
* ```
|
|
4210
4211
|
* @param [cookie = null] - (optional, `null` by default) cookie name
|
|
4211
|
-
* @returns automatically synchronized promise through #recorder
|
|
4212
4212
|
*/
|
|
4213
|
-
clearCookie(cookie?: string):
|
|
4213
|
+
clearCookie(cookie?: string): void;
|
|
4214
4214
|
/**
|
|
4215
4215
|
* Executes a script on the page:
|
|
4216
4216
|
*
|
|
@@ -4342,7 +4342,7 @@ declare namespace CodeceptJS {
|
|
|
4342
4342
|
* @param cssProperties - object with CSS properties and their values to check.
|
|
4343
4343
|
* @returns automatically synchronized promise through #recorder
|
|
4344
4344
|
*/
|
|
4345
|
-
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any):
|
|
4345
|
+
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): void;
|
|
4346
4346
|
/**
|
|
4347
4347
|
* Checks that all elements with given locator have given attributes.
|
|
4348
4348
|
*
|
|
@@ -4353,7 +4353,7 @@ declare namespace CodeceptJS {
|
|
|
4353
4353
|
* @param attributes - attributes and their values to check.
|
|
4354
4354
|
* @returns automatically synchronized promise through #recorder
|
|
4355
4355
|
*/
|
|
4356
|
-
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any):
|
|
4356
|
+
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): void;
|
|
4357
4357
|
/**
|
|
4358
4358
|
* Drag the scrubber of a slider to a given position
|
|
4359
4359
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -4366,7 +4366,7 @@ declare namespace CodeceptJS {
|
|
|
4366
4366
|
* @param offsetX - position to drag.
|
|
4367
4367
|
* @returns automatically synchronized promise through #recorder
|
|
4368
4368
|
*/
|
|
4369
|
-
dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number):
|
|
4369
|
+
dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): void;
|
|
4370
4370
|
/**
|
|
4371
4371
|
* Retrieves an attribute from an element located by CSS or XPath and returns it to test.
|
|
4372
4372
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -4403,7 +4403,7 @@ declare namespace CodeceptJS {
|
|
|
4403
4403
|
* @param fileName - file name to save.
|
|
4404
4404
|
* @returns automatically synchronized promise through #recorder
|
|
4405
4405
|
*/
|
|
4406
|
-
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string):
|
|
4406
|
+
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): void;
|
|
4407
4407
|
/**
|
|
4408
4408
|
* Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
4409
4409
|
* Filename is relative to output folder.
|
|
@@ -4417,7 +4417,7 @@ declare namespace CodeceptJS {
|
|
|
4417
4417
|
* @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
4418
4418
|
* @returns automatically synchronized promise through #recorder
|
|
4419
4419
|
*/
|
|
4420
|
-
saveScreenshot(fileName: string, fullPage?: boolean):
|
|
4420
|
+
saveScreenshot(fileName: string, fullPage?: boolean): void;
|
|
4421
4421
|
/**
|
|
4422
4422
|
* Performs [api request](https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get) using
|
|
4423
4423
|
* the cookies from the current browser session.
|
|
@@ -4444,7 +4444,7 @@ declare namespace CodeceptJS {
|
|
|
4444
4444
|
* @param sec - number of second to wait.
|
|
4445
4445
|
* @returns automatically synchronized promise through #recorder
|
|
4446
4446
|
*/
|
|
4447
|
-
wait(sec: number):
|
|
4447
|
+
wait(sec: number): void;
|
|
4448
4448
|
/**
|
|
4449
4449
|
* Waits for element to become enabled (by default waits for 1sec).
|
|
4450
4450
|
* Element can be located by CSS or XPath.
|
|
@@ -4452,7 +4452,7 @@ declare namespace CodeceptJS {
|
|
|
4452
4452
|
* @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
|
|
4453
4453
|
* @returns automatically synchronized promise through #recorder
|
|
4454
4454
|
*/
|
|
4455
|
-
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4455
|
+
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4456
4456
|
/**
|
|
4457
4457
|
* Waits for the specified value to be in value attribute.
|
|
4458
4458
|
*
|
|
@@ -4464,7 +4464,7 @@ declare namespace CodeceptJS {
|
|
|
4464
4464
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4465
4465
|
* @returns automatically synchronized promise through #recorder
|
|
4466
4466
|
*/
|
|
4467
|
-
waitForValue(field: LocatorOrString, value: string, sec?: number):
|
|
4467
|
+
waitForValue(field: LocatorOrString, value: string, sec?: number): void;
|
|
4468
4468
|
/**
|
|
4469
4469
|
* Waits for a specified number of elements on the page.
|
|
4470
4470
|
*
|
|
@@ -4476,7 +4476,7 @@ declare namespace CodeceptJS {
|
|
|
4476
4476
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4477
4477
|
* @returns automatically synchronized promise through #recorder
|
|
4478
4478
|
*/
|
|
4479
|
-
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number):
|
|
4479
|
+
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): void;
|
|
4480
4480
|
/**
|
|
4481
4481
|
* Waits for element to be clickable (by default waits for 1sec).
|
|
4482
4482
|
* Element can be located by CSS or XPath.
|
|
@@ -4489,7 +4489,7 @@ declare namespace CodeceptJS {
|
|
|
4489
4489
|
* @param [sec] - (optional, `1` by default) time in seconds to wait
|
|
4490
4490
|
* @returns automatically synchronized promise through #recorder
|
|
4491
4491
|
*/
|
|
4492
|
-
waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4492
|
+
waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4493
4493
|
/**
|
|
4494
4494
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
4495
4495
|
* Element can be located by CSS or XPath.
|
|
@@ -4502,7 +4502,7 @@ declare namespace CodeceptJS {
|
|
|
4502
4502
|
* @param [sec] - (optional, `1` by default) time in seconds to wait
|
|
4503
4503
|
* @returns automatically synchronized promise through #recorder
|
|
4504
4504
|
*/
|
|
4505
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4505
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4506
4506
|
/**
|
|
4507
4507
|
* Waits for an element to become visible on a page (by default waits for 1sec).
|
|
4508
4508
|
* Element can be located by CSS or XPath.
|
|
@@ -4517,7 +4517,7 @@ declare namespace CodeceptJS {
|
|
|
4517
4517
|
*
|
|
4518
4518
|
* This method accepts [React selectors](https://codecept.io/react).
|
|
4519
4519
|
*/
|
|
4520
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4520
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4521
4521
|
/**
|
|
4522
4522
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
4523
4523
|
* Element can be located by CSS or XPath.
|
|
@@ -4529,7 +4529,7 @@ declare namespace CodeceptJS {
|
|
|
4529
4529
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4530
4530
|
* @returns automatically synchronized promise through #recorder
|
|
4531
4531
|
*/
|
|
4532
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4532
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4533
4533
|
/**
|
|
4534
4534
|
* Waits for an element to hide (by default waits for 1sec).
|
|
4535
4535
|
* Element can be located by CSS or XPath.
|
|
@@ -4541,7 +4541,7 @@ declare namespace CodeceptJS {
|
|
|
4541
4541
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4542
4542
|
* @returns automatically synchronized promise through #recorder
|
|
4543
4543
|
*/
|
|
4544
|
-
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4544
|
+
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4545
4545
|
/**
|
|
4546
4546
|
* Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
|
|
4547
4547
|
*
|
|
@@ -4552,7 +4552,7 @@ declare namespace CodeceptJS {
|
|
|
4552
4552
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4553
4553
|
* @returns automatically synchronized promise through #recorder
|
|
4554
4554
|
*/
|
|
4555
|
-
waitInUrl(urlPart: string, sec?: number):
|
|
4555
|
+
waitInUrl(urlPart: string, sec?: number): void;
|
|
4556
4556
|
/**
|
|
4557
4557
|
* Waits for the entire URL to match the expected
|
|
4558
4558
|
*
|
|
@@ -4564,7 +4564,7 @@ declare namespace CodeceptJS {
|
|
|
4564
4564
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4565
4565
|
* @returns automatically synchronized promise through #recorder
|
|
4566
4566
|
*/
|
|
4567
|
-
waitUrlEquals(urlPart: string, sec?: number):
|
|
4567
|
+
waitUrlEquals(urlPart: string, sec?: number): void;
|
|
4568
4568
|
/**
|
|
4569
4569
|
* Waits for a text to appear (by default waits for 1sec).
|
|
4570
4570
|
* Element can be located by CSS or XPath.
|
|
@@ -4579,7 +4579,7 @@ declare namespace CodeceptJS {
|
|
|
4579
4579
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
4580
4580
|
* @returns automatically synchronized promise through #recorder
|
|
4581
4581
|
*/
|
|
4582
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
4582
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
4583
4583
|
/**
|
|
4584
4584
|
* Waits for a network request.
|
|
4585
4585
|
*
|
|
@@ -4610,7 +4610,7 @@ declare namespace CodeceptJS {
|
|
|
4610
4610
|
* @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
4611
4611
|
* @returns automatically synchronized promise through #recorder
|
|
4612
4612
|
*/
|
|
4613
|
-
switchTo(locator?: CodeceptJS.LocatorOrString):
|
|
4613
|
+
switchTo(locator?: CodeceptJS.LocatorOrString): void;
|
|
4614
4614
|
/**
|
|
4615
4615
|
* Waits for a function to return true (waits for 1 sec by default).
|
|
4616
4616
|
* Running in browser context.
|
|
@@ -4629,7 +4629,7 @@ declare namespace CodeceptJS {
|
|
|
4629
4629
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
4630
4630
|
* @returns automatically synchronized promise through #recorder
|
|
4631
4631
|
*/
|
|
4632
|
-
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number):
|
|
4632
|
+
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
|
|
4633
4633
|
/**
|
|
4634
4634
|
* Waits for navigation to finish. By default, it takes configured `waitForNavigation` option.
|
|
4635
4635
|
*
|
|
@@ -4654,7 +4654,7 @@ declare namespace CodeceptJS {
|
|
|
4654
4654
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
4655
4655
|
* @returns automatically synchronized promise through #recorder
|
|
4656
4656
|
*/
|
|
4657
|
-
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
4657
|
+
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
4658
4658
|
/**
|
|
4659
4659
|
* Grab the data from performance timing using Navigation Timing API.
|
|
4660
4660
|
* The returned data will contain following things in ms:
|
|
@@ -4677,7 +4677,7 @@ declare namespace CodeceptJS {
|
|
|
4677
4677
|
* ```
|
|
4678
4678
|
* @returns automatically synchronized promise through #recorder
|
|
4679
4679
|
*/
|
|
4680
|
-
grabDataFromPerformanceTiming():
|
|
4680
|
+
grabDataFromPerformanceTiming(): void;
|
|
4681
4681
|
/**
|
|
4682
4682
|
* Grab the width, height, location of given locator.
|
|
4683
4683
|
* Provide `width` or `height`as second param to get your desired prop.
|
|
@@ -5108,7 +5108,7 @@ declare namespace CodeceptJS {
|
|
|
5108
5108
|
* @param url - url path or global url.
|
|
5109
5109
|
* @returns automatically synchronized promise through #recorder
|
|
5110
5110
|
*/
|
|
5111
|
-
amOnPage(url: string):
|
|
5111
|
+
amOnPage(url: string): void;
|
|
5112
5112
|
/**
|
|
5113
5113
|
* Perform a click on a link or a button, given by a locator.
|
|
5114
5114
|
* If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
|
|
@@ -5135,7 +5135,7 @@ declare namespace CodeceptJS {
|
|
|
5135
5135
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
5136
5136
|
* @returns automatically synchronized promise through #recorder
|
|
5137
5137
|
*/
|
|
5138
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null):
|
|
5138
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
|
|
5139
5139
|
/**
|
|
5140
5140
|
* Performs a double-click on an element matched by link|button|label|CSS or XPath.
|
|
5141
5141
|
* Context can be specified as second parameter to narrow search.
|
|
@@ -5150,7 +5150,7 @@ declare namespace CodeceptJS {
|
|
|
5150
5150
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
5151
5151
|
* @returns automatically synchronized promise through #recorder
|
|
5152
5152
|
*/
|
|
5153
|
-
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
5153
|
+
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
5154
5154
|
/**
|
|
5155
5155
|
* Performs right click on a clickable element matched by semantic locator, CSS or XPath.
|
|
5156
5156
|
*
|
|
@@ -5166,7 +5166,7 @@ declare namespace CodeceptJS {
|
|
|
5166
5166
|
* @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
5167
5167
|
* @returns automatically synchronized promise through #recorder
|
|
5168
5168
|
*/
|
|
5169
|
-
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
5169
|
+
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
5170
5170
|
/**
|
|
5171
5171
|
* Moves cursor to element matched by locator.
|
|
5172
5172
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -5180,7 +5180,7 @@ declare namespace CodeceptJS {
|
|
|
5180
5180
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
5181
5181
|
* @returns automatically synchronized promise through #recorder
|
|
5182
5182
|
*/
|
|
5183
|
-
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
5183
|
+
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
5184
5184
|
/**
|
|
5185
5185
|
* Checks that a page contains a visible text.
|
|
5186
5186
|
* Use context parameter to narrow down the search.
|
|
@@ -5194,7 +5194,7 @@ declare namespace CodeceptJS {
|
|
|
5194
5194
|
* @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
5195
5195
|
* @returns automatically synchronized promise through #recorder
|
|
5196
5196
|
*/
|
|
5197
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
5197
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
5198
5198
|
/**
|
|
5199
5199
|
* Checks that text is equal to provided one.
|
|
5200
5200
|
*
|
|
@@ -5205,7 +5205,7 @@ declare namespace CodeceptJS {
|
|
|
5205
5205
|
* @param [context = null] - element located by CSS|XPath|strict locator.
|
|
5206
5206
|
* @returns automatically synchronized promise through #recorder
|
|
5207
5207
|
*/
|
|
5208
|
-
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString):
|
|
5208
|
+
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
5209
5209
|
/**
|
|
5210
5210
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
5211
5211
|
* Use context parameter to narrow down the search.
|
|
@@ -5218,7 +5218,7 @@ declare namespace CodeceptJS {
|
|
|
5218
5218
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
5219
5219
|
* @returns automatically synchronized promise through #recorder
|
|
5220
5220
|
*/
|
|
5221
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
5221
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
5222
5222
|
/**
|
|
5223
5223
|
* Get JS log from browser. Log buffer is reset after each request.
|
|
5224
5224
|
* Resumes test execution, so **should be used inside an async function with `await`** operator.
|
|
@@ -5264,7 +5264,7 @@ declare namespace CodeceptJS {
|
|
|
5264
5264
|
* @param option - visible text or value of option.
|
|
5265
5265
|
* @returns automatically synchronized promise through #recorder
|
|
5266
5266
|
*/
|
|
5267
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
5267
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
5268
5268
|
/**
|
|
5269
5269
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
5270
5270
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -5283,7 +5283,7 @@ declare namespace CodeceptJS {
|
|
|
5283
5283
|
* @param value - text value to fill.
|
|
5284
5284
|
* @returns automatically synchronized promise through #recorder
|
|
5285
5285
|
*/
|
|
5286
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
5286
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
5287
5287
|
/**
|
|
5288
5288
|
* Presses a key on a focused element.
|
|
5289
5289
|
* Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
|
|
@@ -5299,7 +5299,7 @@ declare namespace CodeceptJS {
|
|
|
5299
5299
|
*
|
|
5300
5300
|
* {{ keys }}
|
|
5301
5301
|
*/
|
|
5302
|
-
pressKey(key: string | string[]):
|
|
5302
|
+
pressKey(key: string | string[]): void;
|
|
5303
5303
|
/**
|
|
5304
5304
|
* Attaches a file to element located by label, name, CSS or XPath
|
|
5305
5305
|
* Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
@@ -5313,7 +5313,7 @@ declare namespace CodeceptJS {
|
|
|
5313
5313
|
* @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
|
|
5314
5314
|
* @returns automatically synchronized promise through #recorder
|
|
5315
5315
|
*/
|
|
5316
|
-
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string):
|
|
5316
|
+
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
|
|
5317
5317
|
/**
|
|
5318
5318
|
* Checks that the given input field or textarea equals to given value.
|
|
5319
5319
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -5328,7 +5328,7 @@ declare namespace CodeceptJS {
|
|
|
5328
5328
|
* @param value - value to check.
|
|
5329
5329
|
* @returns automatically synchronized promise through #recorder
|
|
5330
5330
|
*/
|
|
5331
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
5331
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
5332
5332
|
/**
|
|
5333
5333
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
5334
5334
|
* Opposite to `seeInField`.
|
|
@@ -5341,7 +5341,7 @@ declare namespace CodeceptJS {
|
|
|
5341
5341
|
* @param value - value to check.
|
|
5342
5342
|
* @returns automatically synchronized promise through #recorder
|
|
5343
5343
|
*/
|
|
5344
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
5344
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
5345
5345
|
/**
|
|
5346
5346
|
* Appends text to a input field or textarea.
|
|
5347
5347
|
* Field is located by name, label, CSS or XPath
|
|
@@ -5355,7 +5355,7 @@ declare namespace CodeceptJS {
|
|
|
5355
5355
|
* @param value - text value to append.
|
|
5356
5356
|
* @returns automatically synchronized promise through #recorder
|
|
5357
5357
|
*/
|
|
5358
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
5358
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
5359
5359
|
/**
|
|
5360
5360
|
* Clears a `<textarea>` or text `<input>` element's value.
|
|
5361
5361
|
*
|
|
@@ -5367,7 +5367,7 @@ declare namespace CodeceptJS {
|
|
|
5367
5367
|
* @param editable - field located by label|name|CSS|XPath|strict locator.
|
|
5368
5368
|
* @returns automatically synchronized promise through #recorder.
|
|
5369
5369
|
*/
|
|
5370
|
-
clearField(editable: LocatorOrString):
|
|
5370
|
+
clearField(editable: LocatorOrString): void;
|
|
5371
5371
|
/**
|
|
5372
5372
|
* Selects a checkbox or radio button.
|
|
5373
5373
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -5383,7 +5383,7 @@ declare namespace CodeceptJS {
|
|
|
5383
5383
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
5384
5384
|
* @returns automatically synchronized promise through #recorder
|
|
5385
5385
|
*/
|
|
5386
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
5386
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
5387
5387
|
/**
|
|
5388
5388
|
* Unselects a checkbox or radio button.
|
|
5389
5389
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -5399,7 +5399,7 @@ declare namespace CodeceptJS {
|
|
|
5399
5399
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
5400
5400
|
* @returns automatically synchronized promise through #recorder
|
|
5401
5401
|
*/
|
|
5402
|
-
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
5402
|
+
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
5403
5403
|
/**
|
|
5404
5404
|
* Verifies that the specified checkbox is checked.
|
|
5405
5405
|
*
|
|
@@ -5411,7 +5411,7 @@ declare namespace CodeceptJS {
|
|
|
5411
5411
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
5412
5412
|
* @returns automatically synchronized promise through #recorder
|
|
5413
5413
|
*/
|
|
5414
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
5414
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
5415
5415
|
/**
|
|
5416
5416
|
* Verifies that the specified checkbox is not checked.
|
|
5417
5417
|
*
|
|
@@ -5423,7 +5423,7 @@ declare namespace CodeceptJS {
|
|
|
5423
5423
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
5424
5424
|
* @returns automatically synchronized promise through #recorder
|
|
5425
5425
|
*/
|
|
5426
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
5426
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
5427
5427
|
/**
|
|
5428
5428
|
* Retrieves all texts from an element located by CSS or XPath and returns it to test.
|
|
5429
5429
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -5552,7 +5552,7 @@ declare namespace CodeceptJS {
|
|
|
5552
5552
|
* @param text - text value to check.
|
|
5553
5553
|
* @returns automatically synchronized promise through #recorder
|
|
5554
5554
|
*/
|
|
5555
|
-
seeInTitle(text: string):
|
|
5555
|
+
seeInTitle(text: string): void;
|
|
5556
5556
|
/**
|
|
5557
5557
|
* Checks that title is equal to provided one.
|
|
5558
5558
|
*
|
|
@@ -5562,7 +5562,7 @@ declare namespace CodeceptJS {
|
|
|
5562
5562
|
* @param text - value to check.
|
|
5563
5563
|
* @returns automatically synchronized promise through #recorder
|
|
5564
5564
|
*/
|
|
5565
|
-
seeTitleEquals(text: string):
|
|
5565
|
+
seeTitleEquals(text: string): void;
|
|
5566
5566
|
/**
|
|
5567
5567
|
* Checks that title does not contain text.
|
|
5568
5568
|
*
|
|
@@ -5572,7 +5572,7 @@ declare namespace CodeceptJS {
|
|
|
5572
5572
|
* @param text - value to check.
|
|
5573
5573
|
* @returns automatically synchronized promise through #recorder
|
|
5574
5574
|
*/
|
|
5575
|
-
dontSeeInTitle(text: string):
|
|
5575
|
+
dontSeeInTitle(text: string): void;
|
|
5576
5576
|
/**
|
|
5577
5577
|
* Retrieves a page title and returns it to test.
|
|
5578
5578
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -5593,7 +5593,7 @@ declare namespace CodeceptJS {
|
|
|
5593
5593
|
* @param locator - located by CSS|XPath|strict locator.
|
|
5594
5594
|
* @returns automatically synchronized promise through #recorder
|
|
5595
5595
|
*/
|
|
5596
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
5596
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
5597
5597
|
/**
|
|
5598
5598
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
5599
5599
|
*
|
|
@@ -5603,7 +5603,7 @@ declare namespace CodeceptJS {
|
|
|
5603
5603
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
5604
5604
|
* @returns automatically synchronized promise through #recorder
|
|
5605
5605
|
*/
|
|
5606
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
5606
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
5607
5607
|
/**
|
|
5608
5608
|
* Checks that a given Element is present in the DOM
|
|
5609
5609
|
* Element is located by CSS or XPath.
|
|
@@ -5614,7 +5614,7 @@ declare namespace CodeceptJS {
|
|
|
5614
5614
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
5615
5615
|
* @returns automatically synchronized promise through #recorder
|
|
5616
5616
|
*/
|
|
5617
|
-
seeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
5617
|
+
seeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
5618
5618
|
/**
|
|
5619
5619
|
* Opposite to `seeElementInDOM`. Checks that element is not on page.
|
|
5620
5620
|
*
|
|
@@ -5624,7 +5624,7 @@ declare namespace CodeceptJS {
|
|
|
5624
5624
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
5625
5625
|
* @returns automatically synchronized promise through #recorder
|
|
5626
5626
|
*/
|
|
5627
|
-
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
5627
|
+
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
5628
5628
|
/**
|
|
5629
5629
|
* Checks that the current page contains the given string in its raw source code.
|
|
5630
5630
|
*
|
|
@@ -5634,7 +5634,7 @@ declare namespace CodeceptJS {
|
|
|
5634
5634
|
* @param text - value to check.
|
|
5635
5635
|
* @returns automatically synchronized promise through #recorder
|
|
5636
5636
|
*/
|
|
5637
|
-
seeInSource(text: string):
|
|
5637
|
+
seeInSource(text: string): void;
|
|
5638
5638
|
/**
|
|
5639
5639
|
* Retrieves page source and returns it to test.
|
|
5640
5640
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -5654,7 +5654,7 @@ declare namespace CodeceptJS {
|
|
|
5654
5654
|
* @param value - to check.
|
|
5655
5655
|
* @returns automatically synchronized promise through #recorder
|
|
5656
5656
|
*/
|
|
5657
|
-
dontSeeInSource(value: string):
|
|
5657
|
+
dontSeeInSource(value: string): void;
|
|
5658
5658
|
/**
|
|
5659
5659
|
* Asserts that an element appears a given number of times in the DOM.
|
|
5660
5660
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -5667,7 +5667,7 @@ declare namespace CodeceptJS {
|
|
|
5667
5667
|
* @param num - number of elements.
|
|
5668
5668
|
* @returns automatically synchronized promise through #recorder
|
|
5669
5669
|
*/
|
|
5670
|
-
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
5670
|
+
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
5671
5671
|
/**
|
|
5672
5672
|
* Asserts that an element is visible a given number of times.
|
|
5673
5673
|
* Element is located by CSS or XPath.
|
|
@@ -5679,7 +5679,7 @@ declare namespace CodeceptJS {
|
|
|
5679
5679
|
* @param num - number of elements.
|
|
5680
5680
|
* @returns automatically synchronized promise through #recorder
|
|
5681
5681
|
*/
|
|
5682
|
-
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
5682
|
+
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
5683
5683
|
/**
|
|
5684
5684
|
* Grab number of visible elements by locator.
|
|
5685
5685
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -5701,7 +5701,7 @@ declare namespace CodeceptJS {
|
|
|
5701
5701
|
* @param cssProperties - object with CSS properties and their values to check.
|
|
5702
5702
|
* @returns automatically synchronized promise through #recorder
|
|
5703
5703
|
*/
|
|
5704
|
-
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any):
|
|
5704
|
+
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): void;
|
|
5705
5705
|
/**
|
|
5706
5706
|
* Checks that all elements with given locator have given attributes.
|
|
5707
5707
|
*
|
|
@@ -5712,7 +5712,7 @@ declare namespace CodeceptJS {
|
|
|
5712
5712
|
* @param attributes - attributes and their values to check.
|
|
5713
5713
|
* @returns automatically synchronized promise through #recorder
|
|
5714
5714
|
*/
|
|
5715
|
-
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any):
|
|
5715
|
+
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): void;
|
|
5716
5716
|
/**
|
|
5717
5717
|
* Executes sync script on a page.
|
|
5718
5718
|
* Pass arguments to function as additional parameters.
|
|
@@ -5776,13 +5776,13 @@ declare namespace CodeceptJS {
|
|
|
5776
5776
|
* @param url - a fragment to check
|
|
5777
5777
|
* @returns automatically synchronized promise through #recorder
|
|
5778
5778
|
*/
|
|
5779
|
-
seeInCurrentUrl(url: string):
|
|
5779
|
+
seeInCurrentUrl(url: string): void;
|
|
5780
5780
|
/**
|
|
5781
5781
|
* Checks that current url does not contain a provided fragment.
|
|
5782
5782
|
* @param url - value to check.
|
|
5783
5783
|
* @returns automatically synchronized promise through #recorder
|
|
5784
5784
|
*/
|
|
5785
|
-
dontSeeInCurrentUrl(url: string):
|
|
5785
|
+
dontSeeInCurrentUrl(url: string): void;
|
|
5786
5786
|
/**
|
|
5787
5787
|
* Checks that current url is equal to provided one.
|
|
5788
5788
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -5795,7 +5795,7 @@ declare namespace CodeceptJS {
|
|
|
5795
5795
|
* @param url - value to check.
|
|
5796
5796
|
* @returns automatically synchronized promise through #recorder
|
|
5797
5797
|
*/
|
|
5798
|
-
seeCurrentUrlEquals(url: string):
|
|
5798
|
+
seeCurrentUrlEquals(url: string): void;
|
|
5799
5799
|
/**
|
|
5800
5800
|
* Checks that current url is not equal to provided one.
|
|
5801
5801
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -5807,7 +5807,7 @@ declare namespace CodeceptJS {
|
|
|
5807
5807
|
* @param url - value to check.
|
|
5808
5808
|
* @returns automatically synchronized promise through #recorder
|
|
5809
5809
|
*/
|
|
5810
|
-
dontSeeCurrentUrlEquals(url: string):
|
|
5810
|
+
dontSeeCurrentUrlEquals(url: string): void;
|
|
5811
5811
|
/**
|
|
5812
5812
|
* Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
5813
5813
|
* Filename is relative to output folder.
|
|
@@ -5819,7 +5819,7 @@ declare namespace CodeceptJS {
|
|
|
5819
5819
|
* @param fileName - file name to save.
|
|
5820
5820
|
* @returns automatically synchronized promise through #recorder
|
|
5821
5821
|
*/
|
|
5822
|
-
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string):
|
|
5822
|
+
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): void;
|
|
5823
5823
|
/**
|
|
5824
5824
|
* Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
5825
5825
|
* Filename is relative to output folder.
|
|
@@ -5833,19 +5833,18 @@ declare namespace CodeceptJS {
|
|
|
5833
5833
|
* @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
5834
5834
|
* @returns automatically synchronized promise through #recorder
|
|
5835
5835
|
*/
|
|
5836
|
-
saveScreenshot(fileName: string, fullPage?: boolean):
|
|
5836
|
+
saveScreenshot(fileName: string, fullPage?: boolean): void;
|
|
5837
5837
|
/**
|
|
5838
5838
|
* Clears a cookie by name,
|
|
5839
5839
|
* if none provided clears all cookies.
|
|
5840
5840
|
*
|
|
5841
5841
|
* ```js
|
|
5842
5842
|
* I.clearCookie();
|
|
5843
|
-
* I.clearCookie('test');
|
|
5843
|
+
* I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
|
|
5844
5844
|
* ```
|
|
5845
5845
|
* @param [cookie = null] - (optional, `null` by default) cookie name
|
|
5846
|
-
* @returns automatically synchronized promise through #recorder
|
|
5847
5846
|
*/
|
|
5848
|
-
clearCookie(cookie?: string):
|
|
5847
|
+
clearCookie(cookie?: string): void;
|
|
5849
5848
|
/**
|
|
5850
5849
|
* Checks that cookie with given name exists.
|
|
5851
5850
|
*
|
|
@@ -5855,7 +5854,7 @@ declare namespace CodeceptJS {
|
|
|
5855
5854
|
* @param name - cookie name.
|
|
5856
5855
|
* @returns automatically synchronized promise through #recorder
|
|
5857
5856
|
*/
|
|
5858
|
-
seeCookie(name: string):
|
|
5857
|
+
seeCookie(name: string): void;
|
|
5859
5858
|
/**
|
|
5860
5859
|
* Checks that cookie with given name does not exist.
|
|
5861
5860
|
*
|
|
@@ -5865,7 +5864,7 @@ declare namespace CodeceptJS {
|
|
|
5865
5864
|
* @param name - cookie name.
|
|
5866
5865
|
* @returns automatically synchronized promise through #recorder
|
|
5867
5866
|
*/
|
|
5868
|
-
dontSeeCookie(name: string):
|
|
5867
|
+
dontSeeCookie(name: string): void;
|
|
5869
5868
|
/**
|
|
5870
5869
|
* Gets a cookie object by name.
|
|
5871
5870
|
* If none provided gets all cookies.
|
|
@@ -5902,7 +5901,7 @@ declare namespace CodeceptJS {
|
|
|
5902
5901
|
* @param text - value to check.
|
|
5903
5902
|
* @returns automatically synchronized promise through #recorder
|
|
5904
5903
|
*/
|
|
5905
|
-
seeInPopup(text: string):
|
|
5904
|
+
seeInPopup(text: string): void;
|
|
5906
5905
|
/**
|
|
5907
5906
|
* Grab the text within the popup. If no popup is visible then it will return null
|
|
5908
5907
|
*
|
|
@@ -5918,7 +5917,7 @@ declare namespace CodeceptJS {
|
|
|
5918
5917
|
* @param height - height in pixels.
|
|
5919
5918
|
* @returns automatically synchronized promise through #recorder
|
|
5920
5919
|
*/
|
|
5921
|
-
resizeWindow(width: number, height: number):
|
|
5920
|
+
resizeWindow(width: number, height: number): void;
|
|
5922
5921
|
/**
|
|
5923
5922
|
* Drag an item to a destination element.
|
|
5924
5923
|
*
|
|
@@ -5929,7 +5928,7 @@ declare namespace CodeceptJS {
|
|
|
5929
5928
|
* @param destElement - located by CSS|XPath|strict locator.
|
|
5930
5929
|
* @returns automatically synchronized promise through #recorder
|
|
5931
5930
|
*/
|
|
5932
|
-
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString):
|
|
5931
|
+
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): void;
|
|
5933
5932
|
/**
|
|
5934
5933
|
* Close all tabs except for the current one.
|
|
5935
5934
|
*
|
|
@@ -5997,7 +5996,7 @@ declare namespace CodeceptJS {
|
|
|
5997
5996
|
* @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
5998
5997
|
* @returns automatically synchronized promise through #recorder
|
|
5999
5998
|
*/
|
|
6000
|
-
switchTo(locator?: CodeceptJS.LocatorOrString):
|
|
5999
|
+
switchTo(locator?: CodeceptJS.LocatorOrString): void;
|
|
6001
6000
|
/**
|
|
6002
6001
|
* Pauses execution for a number of seconds.
|
|
6003
6002
|
*
|
|
@@ -6007,7 +6006,7 @@ declare namespace CodeceptJS {
|
|
|
6007
6006
|
* @param sec - number of second to wait.
|
|
6008
6007
|
* @returns automatically synchronized promise through #recorder
|
|
6009
6008
|
*/
|
|
6010
|
-
wait(sec: number):
|
|
6009
|
+
wait(sec: number): void;
|
|
6011
6010
|
/**
|
|
6012
6011
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
6013
6012
|
* Element can be located by CSS or XPath.
|
|
@@ -6020,7 +6019,7 @@ declare namespace CodeceptJS {
|
|
|
6020
6019
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
6021
6020
|
* @returns automatically synchronized promise through #recorder
|
|
6022
6021
|
*/
|
|
6023
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
6022
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
6024
6023
|
/**
|
|
6025
6024
|
* Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
|
|
6026
6025
|
* Element can be located by CSS or XPath.
|
|
@@ -6032,7 +6031,7 @@ declare namespace CodeceptJS {
|
|
|
6032
6031
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6033
6032
|
* @returns automatically synchronized promise through #recorder
|
|
6034
6033
|
*/
|
|
6035
|
-
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
6034
|
+
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
6036
6035
|
/**
|
|
6037
6036
|
* Waits for element to become clickable for number of seconds.
|
|
6038
6037
|
*
|
|
@@ -6052,7 +6051,7 @@ declare namespace CodeceptJS {
|
|
|
6052
6051
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6053
6052
|
* @returns automatically synchronized promise through #recorder
|
|
6054
6053
|
*/
|
|
6055
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
6054
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
6056
6055
|
/**
|
|
6057
6056
|
* Waits for an element to hide (by default waits for 1sec).
|
|
6058
6057
|
* Element can be located by CSS or XPath.
|
|
@@ -6064,7 +6063,7 @@ declare namespace CodeceptJS {
|
|
|
6064
6063
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6065
6064
|
* @returns automatically synchronized promise through #recorder
|
|
6066
6065
|
*/
|
|
6067
|
-
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
6066
|
+
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
6068
6067
|
/**
|
|
6069
6068
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
6070
6069
|
* Element can be located by CSS or XPath.
|
|
@@ -6076,7 +6075,7 @@ declare namespace CodeceptJS {
|
|
|
6076
6075
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6077
6076
|
* @returns automatically synchronized promise through #recorder
|
|
6078
6077
|
*/
|
|
6079
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
6078
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
6080
6079
|
/**
|
|
6081
6080
|
* Waits for a specified number of elements on the page.
|
|
6082
6081
|
*
|
|
@@ -6088,7 +6087,7 @@ declare namespace CodeceptJS {
|
|
|
6088
6087
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6089
6088
|
* @returns automatically synchronized promise through #recorder
|
|
6090
6089
|
*/
|
|
6091
|
-
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number):
|
|
6090
|
+
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): void;
|
|
6092
6091
|
/**
|
|
6093
6092
|
* Waits for element to become enabled (by default waits for 1sec).
|
|
6094
6093
|
* Element can be located by CSS or XPath.
|
|
@@ -6096,7 +6095,7 @@ declare namespace CodeceptJS {
|
|
|
6096
6095
|
* @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
|
|
6097
6096
|
* @returns automatically synchronized promise through #recorder
|
|
6098
6097
|
*/
|
|
6099
|
-
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
6098
|
+
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
6100
6099
|
/**
|
|
6101
6100
|
* Waits for the specified value to be in value attribute.
|
|
6102
6101
|
*
|
|
@@ -6108,7 +6107,7 @@ declare namespace CodeceptJS {
|
|
|
6108
6107
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6109
6108
|
* @returns automatically synchronized promise through #recorder
|
|
6110
6109
|
*/
|
|
6111
|
-
waitForValue(field: LocatorOrString, value: string, sec?: number):
|
|
6110
|
+
waitForValue(field: LocatorOrString, value: string, sec?: number): void;
|
|
6112
6111
|
/**
|
|
6113
6112
|
* Waits for a function to return true (waits for 1 sec by default).
|
|
6114
6113
|
* Running in browser context.
|
|
@@ -6127,7 +6126,7 @@ declare namespace CodeceptJS {
|
|
|
6127
6126
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
6128
6127
|
* @returns automatically synchronized promise through #recorder
|
|
6129
6128
|
*/
|
|
6130
|
-
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number):
|
|
6129
|
+
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
|
|
6131
6130
|
/**
|
|
6132
6131
|
* Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
|
|
6133
6132
|
*
|
|
@@ -6138,7 +6137,7 @@ declare namespace CodeceptJS {
|
|
|
6138
6137
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6139
6138
|
* @returns automatically synchronized promise through #recorder
|
|
6140
6139
|
*/
|
|
6141
|
-
waitInUrl(urlPart: string, sec?: number):
|
|
6140
|
+
waitInUrl(urlPart: string, sec?: number): void;
|
|
6142
6141
|
/**
|
|
6143
6142
|
* Waits for the entire URL to match the expected
|
|
6144
6143
|
*
|
|
@@ -6150,7 +6149,7 @@ declare namespace CodeceptJS {
|
|
|
6150
6149
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
6151
6150
|
* @returns automatically synchronized promise through #recorder
|
|
6152
6151
|
*/
|
|
6153
|
-
waitUrlEquals(urlPart: string, sec?: number):
|
|
6152
|
+
waitUrlEquals(urlPart: string, sec?: number): void;
|
|
6154
6153
|
/**
|
|
6155
6154
|
* Waits for a text to appear (by default waits for 1sec).
|
|
6156
6155
|
* Element can be located by CSS or XPath.
|
|
@@ -6165,7 +6164,7 @@ declare namespace CodeceptJS {
|
|
|
6165
6164
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
6166
6165
|
* @returns automatically synchronized promise through #recorder
|
|
6167
6166
|
*/
|
|
6168
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
6167
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
6169
6168
|
/**
|
|
6170
6169
|
* Moves to url
|
|
6171
6170
|
*/
|
|
@@ -6178,7 +6177,7 @@ declare namespace CodeceptJS {
|
|
|
6178
6177
|
* ```
|
|
6179
6178
|
* @returns automatically synchronized promise through #recorder
|
|
6180
6179
|
*/
|
|
6181
|
-
refreshPage():
|
|
6180
|
+
refreshPage(): void;
|
|
6182
6181
|
/**
|
|
6183
6182
|
* Reloads page
|
|
6184
6183
|
*/
|
|
@@ -6196,7 +6195,7 @@ declare namespace CodeceptJS {
|
|
|
6196
6195
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
6197
6196
|
* @returns automatically synchronized promise through #recorder
|
|
6198
6197
|
*/
|
|
6199
|
-
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
6198
|
+
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
6200
6199
|
/**
|
|
6201
6200
|
* Scroll page to the top.
|
|
6202
6201
|
*
|
|
@@ -6205,7 +6204,7 @@ declare namespace CodeceptJS {
|
|
|
6205
6204
|
* ```
|
|
6206
6205
|
* @returns automatically synchronized promise through #recorder
|
|
6207
6206
|
*/
|
|
6208
|
-
scrollPageToTop():
|
|
6207
|
+
scrollPageToTop(): void;
|
|
6209
6208
|
/**
|
|
6210
6209
|
* Scroll page to the bottom.
|
|
6211
6210
|
*
|
|
@@ -6214,7 +6213,7 @@ declare namespace CodeceptJS {
|
|
|
6214
6213
|
* ```
|
|
6215
6214
|
* @returns automatically synchronized promise through #recorder
|
|
6216
6215
|
*/
|
|
6217
|
-
scrollPageToBottom():
|
|
6216
|
+
scrollPageToBottom(): void;
|
|
6218
6217
|
/**
|
|
6219
6218
|
* Retrieves a page scroll position and returns it to test.
|
|
6220
6219
|
* Resumes test execution, so **should be used inside an async function with `await`** operator.
|
|
@@ -6261,7 +6260,7 @@ declare namespace CodeceptJS {
|
|
|
6261
6260
|
* @param cookie - a cookie object or array of cookie objects.
|
|
6262
6261
|
* @returns automatically synchronized promise through #recorder
|
|
6263
6262
|
*/
|
|
6264
|
-
setCookie(cookie: Cookie | Cookie[]):
|
|
6263
|
+
setCookie(cookie: Cookie | Cookie[]): void;
|
|
6265
6264
|
}
|
|
6266
6265
|
/**
|
|
6267
6266
|
* ## Configuration
|
|
@@ -6507,7 +6506,7 @@ declare namespace CodeceptJS {
|
|
|
6507
6506
|
* @param text - value to check.
|
|
6508
6507
|
* @returns automatically synchronized promise through #recorder
|
|
6509
6508
|
*/
|
|
6510
|
-
seeInPopup(text: string):
|
|
6509
|
+
seeInPopup(text: string): void;
|
|
6511
6510
|
/**
|
|
6512
6511
|
* Set current page
|
|
6513
6512
|
* @param page - page to set
|
|
@@ -6541,7 +6540,7 @@ declare namespace CodeceptJS {
|
|
|
6541
6540
|
* @param url - url path or global url.
|
|
6542
6541
|
* @returns automatically synchronized promise through #recorder
|
|
6543
6542
|
*/
|
|
6544
|
-
amOnPage(url: string):
|
|
6543
|
+
amOnPage(url: string): void;
|
|
6545
6544
|
/**
|
|
6546
6545
|
* Resize the current window to provided width and height.
|
|
6547
6546
|
* First parameter can be set to `maximize`.
|
|
@@ -6554,7 +6553,7 @@ declare namespace CodeceptJS {
|
|
|
6554
6553
|
* Puppeteer does not control the window of a browser so it can't adjust its real size.
|
|
6555
6554
|
* It also can't maximize a window.
|
|
6556
6555
|
*/
|
|
6557
|
-
resizeWindow(width: number, height: number):
|
|
6556
|
+
resizeWindow(width: number, height: number): void;
|
|
6558
6557
|
/**
|
|
6559
6558
|
* Set headers for all next requests
|
|
6560
6559
|
*
|
|
@@ -6581,7 +6580,7 @@ declare namespace CodeceptJS {
|
|
|
6581
6580
|
*
|
|
6582
6581
|
* {{ react }}
|
|
6583
6582
|
*/
|
|
6584
|
-
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
6583
|
+
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
6585
6584
|
/**
|
|
6586
6585
|
* Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
|
|
6587
6586
|
*
|
|
@@ -6596,7 +6595,7 @@ declare namespace CodeceptJS {
|
|
|
6596
6595
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
|
|
6597
6596
|
* @returns automatically synchronized promise through #recorder
|
|
6598
6597
|
*/
|
|
6599
|
-
focus(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
6598
|
+
focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
6600
6599
|
/**
|
|
6601
6600
|
* Remove focus from a text input, button, etc.
|
|
6602
6601
|
* Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
|
|
@@ -6616,7 +6615,7 @@ declare namespace CodeceptJS {
|
|
|
6616
6615
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
|
|
6617
6616
|
* @returns automatically synchronized promise through #recorder
|
|
6618
6617
|
*/
|
|
6619
|
-
blur(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
6618
|
+
blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
6620
6619
|
/**
|
|
6621
6620
|
* Drag an item to a destination element.
|
|
6622
6621
|
*
|
|
@@ -6627,7 +6626,7 @@ declare namespace CodeceptJS {
|
|
|
6627
6626
|
* @param destElement - located by CSS|XPath|strict locator.
|
|
6628
6627
|
* @returns automatically synchronized promise through #recorder
|
|
6629
6628
|
*/
|
|
6630
|
-
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString):
|
|
6629
|
+
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): void;
|
|
6631
6630
|
/**
|
|
6632
6631
|
* Reload the current page.
|
|
6633
6632
|
*
|
|
@@ -6636,7 +6635,7 @@ declare namespace CodeceptJS {
|
|
|
6636
6635
|
* ```
|
|
6637
6636
|
* @returns automatically synchronized promise through #recorder
|
|
6638
6637
|
*/
|
|
6639
|
-
refreshPage():
|
|
6638
|
+
refreshPage(): void;
|
|
6640
6639
|
/**
|
|
6641
6640
|
* Scroll page to the top.
|
|
6642
6641
|
*
|
|
@@ -6645,7 +6644,7 @@ declare namespace CodeceptJS {
|
|
|
6645
6644
|
* ```
|
|
6646
6645
|
* @returns automatically synchronized promise through #recorder
|
|
6647
6646
|
*/
|
|
6648
|
-
scrollPageToTop():
|
|
6647
|
+
scrollPageToTop(): void;
|
|
6649
6648
|
/**
|
|
6650
6649
|
* Scroll page to the bottom.
|
|
6651
6650
|
*
|
|
@@ -6654,7 +6653,7 @@ declare namespace CodeceptJS {
|
|
|
6654
6653
|
* ```
|
|
6655
6654
|
* @returns automatically synchronized promise through #recorder
|
|
6656
6655
|
*/
|
|
6657
|
-
scrollPageToBottom():
|
|
6656
|
+
scrollPageToBottom(): void;
|
|
6658
6657
|
/**
|
|
6659
6658
|
* Scrolls to element matched by locator.
|
|
6660
6659
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -6668,7 +6667,7 @@ declare namespace CodeceptJS {
|
|
|
6668
6667
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
6669
6668
|
* @returns automatically synchronized promise through #recorder
|
|
6670
6669
|
*/
|
|
6671
|
-
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
6670
|
+
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
6672
6671
|
/**
|
|
6673
6672
|
* Checks that title contains text.
|
|
6674
6673
|
*
|
|
@@ -6678,7 +6677,7 @@ declare namespace CodeceptJS {
|
|
|
6678
6677
|
* @param text - text value to check.
|
|
6679
6678
|
* @returns automatically synchronized promise through #recorder
|
|
6680
6679
|
*/
|
|
6681
|
-
seeInTitle(text: string):
|
|
6680
|
+
seeInTitle(text: string): void;
|
|
6682
6681
|
/**
|
|
6683
6682
|
* Retrieves a page scroll position and returns it to test.
|
|
6684
6683
|
* Resumes test execution, so **should be used inside an async function with `await`** operator.
|
|
@@ -6698,7 +6697,7 @@ declare namespace CodeceptJS {
|
|
|
6698
6697
|
* @param text - value to check.
|
|
6699
6698
|
* @returns automatically synchronized promise through #recorder
|
|
6700
6699
|
*/
|
|
6701
|
-
seeTitleEquals(text: string):
|
|
6700
|
+
seeTitleEquals(text: string): void;
|
|
6702
6701
|
/**
|
|
6703
6702
|
* Checks that title does not contain text.
|
|
6704
6703
|
*
|
|
@@ -6708,7 +6707,7 @@ declare namespace CodeceptJS {
|
|
|
6708
6707
|
* @param text - value to check.
|
|
6709
6708
|
* @returns automatically synchronized promise through #recorder
|
|
6710
6709
|
*/
|
|
6711
|
-
dontSeeInTitle(text: string):
|
|
6710
|
+
dontSeeInTitle(text: string): void;
|
|
6712
6711
|
/**
|
|
6713
6712
|
* Retrieves a page title and returns it to test.
|
|
6714
6713
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -6819,7 +6818,7 @@ declare namespace CodeceptJS {
|
|
|
6819
6818
|
*
|
|
6820
6819
|
* {{ react }}
|
|
6821
6820
|
*/
|
|
6822
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
6821
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
6823
6822
|
/**
|
|
6824
6823
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
6825
6824
|
*
|
|
@@ -6831,7 +6830,7 @@ declare namespace CodeceptJS {
|
|
|
6831
6830
|
*
|
|
6832
6831
|
* {{ react }}
|
|
6833
6832
|
*/
|
|
6834
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
6833
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
6835
6834
|
/**
|
|
6836
6835
|
* Checks that a given Element is present in the DOM
|
|
6837
6836
|
* Element is located by CSS or XPath.
|
|
@@ -6842,7 +6841,7 @@ declare namespace CodeceptJS {
|
|
|
6842
6841
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
6843
6842
|
* @returns automatically synchronized promise through #recorder
|
|
6844
6843
|
*/
|
|
6845
|
-
seeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
6844
|
+
seeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
6846
6845
|
/**
|
|
6847
6846
|
* Opposite to `seeElementInDOM`. Checks that element is not on page.
|
|
6848
6847
|
*
|
|
@@ -6852,7 +6851,7 @@ declare namespace CodeceptJS {
|
|
|
6852
6851
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
6853
6852
|
* @returns automatically synchronized promise through #recorder
|
|
6854
6853
|
*/
|
|
6855
|
-
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
6854
|
+
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
6856
6855
|
/**
|
|
6857
6856
|
* Perform a click on a link or a button, given by a locator.
|
|
6858
6857
|
* If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
|
|
@@ -6882,7 +6881,7 @@ declare namespace CodeceptJS {
|
|
|
6882
6881
|
*
|
|
6883
6882
|
* {{ react }}
|
|
6884
6883
|
*/
|
|
6885
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null):
|
|
6884
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
|
|
6886
6885
|
/**
|
|
6887
6886
|
* Perform an emulated click on a link or a button, given by a locator.
|
|
6888
6887
|
* Unlike normal click instead of sending native event, emulates a click with JavaScript.
|
|
@@ -6915,7 +6914,7 @@ declare namespace CodeceptJS {
|
|
|
6915
6914
|
*
|
|
6916
6915
|
* {{ react }}
|
|
6917
6916
|
*/
|
|
6918
|
-
forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
6917
|
+
forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
6919
6918
|
/**
|
|
6920
6919
|
* Performs a click on a link and waits for navigation before moving on.
|
|
6921
6920
|
*
|
|
@@ -6929,7 +6928,7 @@ declare namespace CodeceptJS {
|
|
|
6929
6928
|
*
|
|
6930
6929
|
* {{ react }}
|
|
6931
6930
|
*/
|
|
6932
|
-
clickLink(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
6931
|
+
clickLink(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
6933
6932
|
/**
|
|
6934
6933
|
* Sets a directory to where save files. Allows to test file downloads.
|
|
6935
6934
|
* Should be used with [FileSystem helper](https://codecept.io/helpers/FileSystem) to check that file were downloaded correctly.
|
|
@@ -6970,7 +6969,7 @@ declare namespace CodeceptJS {
|
|
|
6970
6969
|
*
|
|
6971
6970
|
* {{ react }}
|
|
6972
6971
|
*/
|
|
6973
|
-
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
6972
|
+
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
6974
6973
|
/**
|
|
6975
6974
|
* Performs right click on a clickable element matched by semantic locator, CSS or XPath.
|
|
6976
6975
|
*
|
|
@@ -6989,7 +6988,7 @@ declare namespace CodeceptJS {
|
|
|
6989
6988
|
*
|
|
6990
6989
|
* {{ react }}
|
|
6991
6990
|
*/
|
|
6992
|
-
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
6991
|
+
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
6993
6992
|
/**
|
|
6994
6993
|
* Selects a checkbox or radio button.
|
|
6995
6994
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -7005,7 +7004,7 @@ declare namespace CodeceptJS {
|
|
|
7005
7004
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
7006
7005
|
* @returns automatically synchronized promise through #recorder
|
|
7007
7006
|
*/
|
|
7008
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
7007
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
7009
7008
|
/**
|
|
7010
7009
|
* Unselects a checkbox or radio button.
|
|
7011
7010
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -7021,7 +7020,7 @@ declare namespace CodeceptJS {
|
|
|
7021
7020
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
7022
7021
|
* @returns automatically synchronized promise through #recorder
|
|
7023
7022
|
*/
|
|
7024
|
-
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
7023
|
+
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
7025
7024
|
/**
|
|
7026
7025
|
* Verifies that the specified checkbox is checked.
|
|
7027
7026
|
*
|
|
@@ -7033,7 +7032,7 @@ declare namespace CodeceptJS {
|
|
|
7033
7032
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
7034
7033
|
* @returns automatically synchronized promise through #recorder
|
|
7035
7034
|
*/
|
|
7036
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
7035
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
7037
7036
|
/**
|
|
7038
7037
|
* Verifies that the specified checkbox is not checked.
|
|
7039
7038
|
*
|
|
@@ -7045,7 +7044,7 @@ declare namespace CodeceptJS {
|
|
|
7045
7044
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
7046
7045
|
* @returns automatically synchronized promise through #recorder
|
|
7047
7046
|
*/
|
|
7048
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
7047
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
7049
7048
|
/**
|
|
7050
7049
|
* Presses a key in the browser and leaves it in a down state.
|
|
7051
7050
|
*
|
|
@@ -7059,7 +7058,7 @@ declare namespace CodeceptJS {
|
|
|
7059
7058
|
* @param key - name of key to press down.
|
|
7060
7059
|
* @returns automatically synchronized promise through #recorder
|
|
7061
7060
|
*/
|
|
7062
|
-
pressKeyDown(key: string):
|
|
7061
|
+
pressKeyDown(key: string): void;
|
|
7063
7062
|
/**
|
|
7064
7063
|
* Releases a key in the browser which was previously set to a down state.
|
|
7065
7064
|
*
|
|
@@ -7073,7 +7072,7 @@ declare namespace CodeceptJS {
|
|
|
7073
7072
|
* @param key - name of key to release.
|
|
7074
7073
|
* @returns automatically synchronized promise through #recorder
|
|
7075
7074
|
*/
|
|
7076
|
-
pressKeyUp(key: string):
|
|
7075
|
+
pressKeyUp(key: string): void;
|
|
7077
7076
|
/**
|
|
7078
7077
|
* Presses a key in the browser (on a focused element).
|
|
7079
7078
|
*
|
|
@@ -7138,7 +7137,7 @@ declare namespace CodeceptJS {
|
|
|
7138
7137
|
*
|
|
7139
7138
|
* _Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/puppeteer#1313](https://github.com/GoogleChrome/puppeteer/issues/1313)).
|
|
7140
7139
|
*/
|
|
7141
|
-
pressKey(key: string | string[]):
|
|
7140
|
+
pressKey(key: string | string[]): void;
|
|
7142
7141
|
/**
|
|
7143
7142
|
* Types out the given text into an active field.
|
|
7144
7143
|
* To slow down typing use a second parameter, to set interval between key presses.
|
|
@@ -7161,7 +7160,7 @@ declare namespace CodeceptJS {
|
|
|
7161
7160
|
* @param [delay = null] - (optional) delay in ms between key presses
|
|
7162
7161
|
* @returns automatically synchronized promise through #recorder
|
|
7163
7162
|
*/
|
|
7164
|
-
type(key: string | string[], delay?: number):
|
|
7163
|
+
type(key: string | string[], delay?: number): void;
|
|
7165
7164
|
/**
|
|
7166
7165
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
7167
7166
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -7182,7 +7181,7 @@ declare namespace CodeceptJS {
|
|
|
7182
7181
|
*
|
|
7183
7182
|
* {{ react }}
|
|
7184
7183
|
*/
|
|
7185
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
7184
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
7186
7185
|
/**
|
|
7187
7186
|
* Clears a `<textarea>` or text `<input>` element's value.
|
|
7188
7187
|
*
|
|
@@ -7194,7 +7193,7 @@ declare namespace CodeceptJS {
|
|
|
7194
7193
|
* @param editable - field located by label|name|CSS|XPath|strict locator.
|
|
7195
7194
|
* @returns automatically synchronized promise through #recorder.
|
|
7196
7195
|
*/
|
|
7197
|
-
clearField(editable: LocatorOrString):
|
|
7196
|
+
clearField(editable: LocatorOrString): void;
|
|
7198
7197
|
/**
|
|
7199
7198
|
* Appends text to a input field or textarea.
|
|
7200
7199
|
* Field is located by name, label, CSS or XPath
|
|
@@ -7211,7 +7210,7 @@ declare namespace CodeceptJS {
|
|
|
7211
7210
|
*
|
|
7212
7211
|
* {{ react }}
|
|
7213
7212
|
*/
|
|
7214
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
7213
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
7215
7214
|
/**
|
|
7216
7215
|
* Checks that the given input field or textarea equals to given value.
|
|
7217
7216
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -7226,7 +7225,7 @@ declare namespace CodeceptJS {
|
|
|
7226
7225
|
* @param value - value to check.
|
|
7227
7226
|
* @returns automatically synchronized promise through #recorder
|
|
7228
7227
|
*/
|
|
7229
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
7228
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
7230
7229
|
/**
|
|
7231
7230
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
7232
7231
|
* Opposite to `seeInField`.
|
|
@@ -7239,7 +7238,7 @@ declare namespace CodeceptJS {
|
|
|
7239
7238
|
* @param value - value to check.
|
|
7240
7239
|
* @returns automatically synchronized promise through #recorder
|
|
7241
7240
|
*/
|
|
7242
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
7241
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
7243
7242
|
/**
|
|
7244
7243
|
* Attaches a file to element located by label, name, CSS or XPath
|
|
7245
7244
|
* Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
@@ -7256,7 +7255,7 @@ declare namespace CodeceptJS {
|
|
|
7256
7255
|
*
|
|
7257
7256
|
* > ⚠ 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.
|
|
7258
7257
|
*/
|
|
7259
|
-
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string):
|
|
7258
|
+
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
|
|
7260
7259
|
/**
|
|
7261
7260
|
* Selects an option in a drop-down select.
|
|
7262
7261
|
* Field is searched by label | name | CSS | XPath.
|
|
@@ -7280,7 +7279,7 @@ declare namespace CodeceptJS {
|
|
|
7280
7279
|
* @param option - visible text or value of option.
|
|
7281
7280
|
* @returns automatically synchronized promise through #recorder
|
|
7282
7281
|
*/
|
|
7283
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
7282
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
7284
7283
|
/**
|
|
7285
7284
|
* Grab number of visible elements by locator.
|
|
7286
7285
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -7302,13 +7301,13 @@ declare namespace CodeceptJS {
|
|
|
7302
7301
|
* @param url - a fragment to check
|
|
7303
7302
|
* @returns automatically synchronized promise through #recorder
|
|
7304
7303
|
*/
|
|
7305
|
-
seeInCurrentUrl(url: string):
|
|
7304
|
+
seeInCurrentUrl(url: string): void;
|
|
7306
7305
|
/**
|
|
7307
7306
|
* Checks that current url does not contain a provided fragment.
|
|
7308
7307
|
* @param url - value to check.
|
|
7309
7308
|
* @returns automatically synchronized promise through #recorder
|
|
7310
7309
|
*/
|
|
7311
|
-
dontSeeInCurrentUrl(url: string):
|
|
7310
|
+
dontSeeInCurrentUrl(url: string): void;
|
|
7312
7311
|
/**
|
|
7313
7312
|
* Checks that current url is equal to provided one.
|
|
7314
7313
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -7321,7 +7320,7 @@ declare namespace CodeceptJS {
|
|
|
7321
7320
|
* @param url - value to check.
|
|
7322
7321
|
* @returns automatically synchronized promise through #recorder
|
|
7323
7322
|
*/
|
|
7324
|
-
seeCurrentUrlEquals(url: string):
|
|
7323
|
+
seeCurrentUrlEquals(url: string): void;
|
|
7325
7324
|
/**
|
|
7326
7325
|
* Checks that current url is not equal to provided one.
|
|
7327
7326
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -7333,7 +7332,7 @@ declare namespace CodeceptJS {
|
|
|
7333
7332
|
* @param url - value to check.
|
|
7334
7333
|
* @returns automatically synchronized promise through #recorder
|
|
7335
7334
|
*/
|
|
7336
|
-
dontSeeCurrentUrlEquals(url: string):
|
|
7335
|
+
dontSeeCurrentUrlEquals(url: string): void;
|
|
7337
7336
|
/**
|
|
7338
7337
|
* Checks that a page contains a visible text.
|
|
7339
7338
|
* Use context parameter to narrow down the search.
|
|
@@ -7350,7 +7349,7 @@ declare namespace CodeceptJS {
|
|
|
7350
7349
|
*
|
|
7351
7350
|
* {{ react }}
|
|
7352
7351
|
*/
|
|
7353
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
7352
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
7354
7353
|
/**
|
|
7355
7354
|
* Checks that text is equal to provided one.
|
|
7356
7355
|
*
|
|
@@ -7361,7 +7360,7 @@ declare namespace CodeceptJS {
|
|
|
7361
7360
|
* @param [context = null] - element located by CSS|XPath|strict locator.
|
|
7362
7361
|
* @returns automatically synchronized promise through #recorder
|
|
7363
7362
|
*/
|
|
7364
|
-
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString):
|
|
7363
|
+
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
7365
7364
|
/**
|
|
7366
7365
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
7367
7366
|
* Use context parameter to narrow down the search.
|
|
@@ -7377,7 +7376,7 @@ declare namespace CodeceptJS {
|
|
|
7377
7376
|
*
|
|
7378
7377
|
* {{ react }}
|
|
7379
7378
|
*/
|
|
7380
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
7379
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
7381
7380
|
/**
|
|
7382
7381
|
* Retrieves page source and returns it to test.
|
|
7383
7382
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -7417,7 +7416,7 @@ declare namespace CodeceptJS {
|
|
|
7417
7416
|
* @param text - value to check.
|
|
7418
7417
|
* @returns automatically synchronized promise through #recorder
|
|
7419
7418
|
*/
|
|
7420
|
-
seeInSource(text: string):
|
|
7419
|
+
seeInSource(text: string): void;
|
|
7421
7420
|
/**
|
|
7422
7421
|
* Checks that the current page does not contains the given string in its raw source code.
|
|
7423
7422
|
*
|
|
@@ -7427,7 +7426,7 @@ declare namespace CodeceptJS {
|
|
|
7427
7426
|
* @param value - to check.
|
|
7428
7427
|
* @returns automatically synchronized promise through #recorder
|
|
7429
7428
|
*/
|
|
7430
|
-
dontSeeInSource(value: string):
|
|
7429
|
+
dontSeeInSource(value: string): void;
|
|
7431
7430
|
/**
|
|
7432
7431
|
* Asserts that an element appears a given number of times in the DOM.
|
|
7433
7432
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -7443,7 +7442,7 @@ declare namespace CodeceptJS {
|
|
|
7443
7442
|
*
|
|
7444
7443
|
* {{ react }}
|
|
7445
7444
|
*/
|
|
7446
|
-
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
7445
|
+
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
7447
7446
|
/**
|
|
7448
7447
|
* Asserts that an element is visible a given number of times.
|
|
7449
7448
|
* Element is located by CSS or XPath.
|
|
@@ -7458,7 +7457,7 @@ declare namespace CodeceptJS {
|
|
|
7458
7457
|
*
|
|
7459
7458
|
* {{ react }}
|
|
7460
7459
|
*/
|
|
7461
|
-
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
7460
|
+
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
7462
7461
|
/**
|
|
7463
7462
|
* Sets cookie(s).
|
|
7464
7463
|
*
|
|
@@ -7476,7 +7475,7 @@ declare namespace CodeceptJS {
|
|
|
7476
7475
|
* @param cookie - a cookie object or array of cookie objects.
|
|
7477
7476
|
* @returns automatically synchronized promise through #recorder
|
|
7478
7477
|
*/
|
|
7479
|
-
setCookie(cookie: Cookie | Cookie[]):
|
|
7478
|
+
setCookie(cookie: Cookie | Cookie[]): void;
|
|
7480
7479
|
/**
|
|
7481
7480
|
* Checks that cookie with given name exists.
|
|
7482
7481
|
*
|
|
@@ -7486,7 +7485,7 @@ declare namespace CodeceptJS {
|
|
|
7486
7485
|
* @param name - cookie name.
|
|
7487
7486
|
* @returns automatically synchronized promise through #recorder
|
|
7488
7487
|
*/
|
|
7489
|
-
seeCookie(name: string):
|
|
7488
|
+
seeCookie(name: string): void;
|
|
7490
7489
|
/**
|
|
7491
7490
|
* Checks that cookie with given name does not exist.
|
|
7492
7491
|
*
|
|
@@ -7496,7 +7495,7 @@ declare namespace CodeceptJS {
|
|
|
7496
7495
|
* @param name - cookie name.
|
|
7497
7496
|
* @returns automatically synchronized promise through #recorder
|
|
7498
7497
|
*/
|
|
7499
|
-
dontSeeCookie(name: string):
|
|
7498
|
+
dontSeeCookie(name: string): void;
|
|
7500
7499
|
/**
|
|
7501
7500
|
* Gets a cookie object by name.
|
|
7502
7501
|
* If none provided gets all cookies.
|
|
@@ -7519,12 +7518,11 @@ declare namespace CodeceptJS {
|
|
|
7519
7518
|
*
|
|
7520
7519
|
* ```js
|
|
7521
7520
|
* I.clearCookie();
|
|
7522
|
-
* I.clearCookie('test');
|
|
7521
|
+
* I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
|
|
7523
7522
|
* ```
|
|
7524
7523
|
* @param [cookie = null] - (optional, `null` by default) cookie name
|
|
7525
|
-
* @returns automatically synchronized promise through #recorder
|
|
7526
7524
|
*/
|
|
7527
|
-
clearCookie(cookie?: string):
|
|
7525
|
+
clearCookie(cookie?: string): void;
|
|
7528
7526
|
/**
|
|
7529
7527
|
* Executes sync script on a page.
|
|
7530
7528
|
* Pass arguments to function as additional parameters.
|
|
@@ -7699,7 +7697,7 @@ declare namespace CodeceptJS {
|
|
|
7699
7697
|
*
|
|
7700
7698
|
* {{ react }}
|
|
7701
7699
|
*/
|
|
7702
|
-
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any):
|
|
7700
|
+
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): void;
|
|
7703
7701
|
/**
|
|
7704
7702
|
* Checks that all elements with given locator have given attributes.
|
|
7705
7703
|
*
|
|
@@ -7712,7 +7710,7 @@ declare namespace CodeceptJS {
|
|
|
7712
7710
|
*
|
|
7713
7711
|
* {{ react }}
|
|
7714
7712
|
*/
|
|
7715
|
-
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any):
|
|
7713
|
+
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): void;
|
|
7716
7714
|
/**
|
|
7717
7715
|
* Drag the scrubber of a slider to a given position
|
|
7718
7716
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -7727,7 +7725,7 @@ declare namespace CodeceptJS {
|
|
|
7727
7725
|
*
|
|
7728
7726
|
* {{ react }}
|
|
7729
7727
|
*/
|
|
7730
|
-
dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number):
|
|
7728
|
+
dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): void;
|
|
7731
7729
|
/**
|
|
7732
7730
|
* Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
|
|
7733
7731
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -7768,7 +7766,7 @@ declare namespace CodeceptJS {
|
|
|
7768
7766
|
* @param fileName - file name to save.
|
|
7769
7767
|
* @returns automatically synchronized promise through #recorder
|
|
7770
7768
|
*/
|
|
7771
|
-
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string):
|
|
7769
|
+
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): void;
|
|
7772
7770
|
/**
|
|
7773
7771
|
* Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
7774
7772
|
* Filename is relative to output folder.
|
|
@@ -7782,7 +7780,7 @@ declare namespace CodeceptJS {
|
|
|
7782
7780
|
* @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
7783
7781
|
* @returns automatically synchronized promise through #recorder
|
|
7784
7782
|
*/
|
|
7785
|
-
saveScreenshot(fileName: string, fullPage?: boolean):
|
|
7783
|
+
saveScreenshot(fileName: string, fullPage?: boolean): void;
|
|
7786
7784
|
/**
|
|
7787
7785
|
* Pauses execution for a number of seconds.
|
|
7788
7786
|
*
|
|
@@ -7792,7 +7790,7 @@ declare namespace CodeceptJS {
|
|
|
7792
7790
|
* @param sec - number of second to wait.
|
|
7793
7791
|
* @returns automatically synchronized promise through #recorder
|
|
7794
7792
|
*/
|
|
7795
|
-
wait(sec: number):
|
|
7793
|
+
wait(sec: number): void;
|
|
7796
7794
|
/**
|
|
7797
7795
|
* Waits for element to become enabled (by default waits for 1sec).
|
|
7798
7796
|
* Element can be located by CSS or XPath.
|
|
@@ -7800,7 +7798,7 @@ declare namespace CodeceptJS {
|
|
|
7800
7798
|
* @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
|
|
7801
7799
|
* @returns automatically synchronized promise through #recorder
|
|
7802
7800
|
*/
|
|
7803
|
-
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
7801
|
+
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
7804
7802
|
/**
|
|
7805
7803
|
* Waits for the specified value to be in value attribute.
|
|
7806
7804
|
*
|
|
@@ -7812,7 +7810,7 @@ declare namespace CodeceptJS {
|
|
|
7812
7810
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
7813
7811
|
* @returns automatically synchronized promise through #recorder
|
|
7814
7812
|
*/
|
|
7815
|
-
waitForValue(field: LocatorOrString, value: string, sec?: number):
|
|
7813
|
+
waitForValue(field: LocatorOrString, value: string, sec?: number): void;
|
|
7816
7814
|
/**
|
|
7817
7815
|
* Waits for a specified number of elements on the page.
|
|
7818
7816
|
*
|
|
@@ -7826,7 +7824,7 @@ declare namespace CodeceptJS {
|
|
|
7826
7824
|
*
|
|
7827
7825
|
* {{ react }}
|
|
7828
7826
|
*/
|
|
7829
|
-
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number):
|
|
7827
|
+
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): void;
|
|
7830
7828
|
/**
|
|
7831
7829
|
* Waits for element to be clickable (by default waits for 1sec).
|
|
7832
7830
|
* Element can be located by CSS or XPath.
|
|
@@ -7839,7 +7837,7 @@ declare namespace CodeceptJS {
|
|
|
7839
7837
|
* @param [sec] - (optional, `1` by default) time in seconds to wait
|
|
7840
7838
|
* @returns automatically synchronized promise through #recorder
|
|
7841
7839
|
*/
|
|
7842
|
-
waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
7840
|
+
waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
7843
7841
|
/**
|
|
7844
7842
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
7845
7843
|
* Element can be located by CSS or XPath.
|
|
@@ -7854,7 +7852,7 @@ declare namespace CodeceptJS {
|
|
|
7854
7852
|
*
|
|
7855
7853
|
* {{ react }}
|
|
7856
7854
|
*/
|
|
7857
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
7855
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
7858
7856
|
/**
|
|
7859
7857
|
* Waits for an element to become visible on a page (by default waits for 1sec).
|
|
7860
7858
|
* Element can be located by CSS or XPath.
|
|
@@ -7869,7 +7867,7 @@ declare namespace CodeceptJS {
|
|
|
7869
7867
|
*
|
|
7870
7868
|
* This method accepts [React selectors](https://codecept.io/react).
|
|
7871
7869
|
*/
|
|
7872
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
7870
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
7873
7871
|
/**
|
|
7874
7872
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
7875
7873
|
* Element can be located by CSS or XPath.
|
|
@@ -7881,7 +7879,7 @@ declare namespace CodeceptJS {
|
|
|
7881
7879
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
7882
7880
|
* @returns automatically synchronized promise through #recorder
|
|
7883
7881
|
*/
|
|
7884
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
7882
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
7885
7883
|
/**
|
|
7886
7884
|
* Waits for an element to hide (by default waits for 1sec).
|
|
7887
7885
|
* Element can be located by CSS or XPath.
|
|
@@ -7893,7 +7891,7 @@ declare namespace CodeceptJS {
|
|
|
7893
7891
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
7894
7892
|
* @returns automatically synchronized promise through #recorder
|
|
7895
7893
|
*/
|
|
7896
|
-
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
7894
|
+
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
7897
7895
|
/**
|
|
7898
7896
|
* Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
|
|
7899
7897
|
*
|
|
@@ -7904,7 +7902,7 @@ declare namespace CodeceptJS {
|
|
|
7904
7902
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
7905
7903
|
* @returns automatically synchronized promise through #recorder
|
|
7906
7904
|
*/
|
|
7907
|
-
waitInUrl(urlPart: string, sec?: number):
|
|
7905
|
+
waitInUrl(urlPart: string, sec?: number): void;
|
|
7908
7906
|
/**
|
|
7909
7907
|
* Waits for the entire URL to match the expected
|
|
7910
7908
|
*
|
|
@@ -7916,7 +7914,7 @@ declare namespace CodeceptJS {
|
|
|
7916
7914
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
7917
7915
|
* @returns automatically synchronized promise through #recorder
|
|
7918
7916
|
*/
|
|
7919
|
-
waitUrlEquals(urlPart: string, sec?: number):
|
|
7917
|
+
waitUrlEquals(urlPart: string, sec?: number): void;
|
|
7920
7918
|
/**
|
|
7921
7919
|
* Waits for a text to appear (by default waits for 1sec).
|
|
7922
7920
|
* Element can be located by CSS or XPath.
|
|
@@ -7931,7 +7929,7 @@ declare namespace CodeceptJS {
|
|
|
7931
7929
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
7932
7930
|
* @returns automatically synchronized promise through #recorder
|
|
7933
7931
|
*/
|
|
7934
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
7932
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
7935
7933
|
/**
|
|
7936
7934
|
* Waits for a network request.
|
|
7937
7935
|
*
|
|
@@ -7962,7 +7960,7 @@ declare namespace CodeceptJS {
|
|
|
7962
7960
|
* @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
7963
7961
|
* @returns automatically synchronized promise through #recorder
|
|
7964
7962
|
*/
|
|
7965
|
-
switchTo(locator?: CodeceptJS.LocatorOrString):
|
|
7963
|
+
switchTo(locator?: CodeceptJS.LocatorOrString): void;
|
|
7966
7964
|
/**
|
|
7967
7965
|
* Waits for a function to return true (waits for 1 sec by default).
|
|
7968
7966
|
* Running in browser context.
|
|
@@ -7981,7 +7979,7 @@ declare namespace CodeceptJS {
|
|
|
7981
7979
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
7982
7980
|
* @returns automatically synchronized promise through #recorder
|
|
7983
7981
|
*/
|
|
7984
|
-
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number):
|
|
7982
|
+
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
|
|
7985
7983
|
/**
|
|
7986
7984
|
* Waits for navigation to finish. By default takes configured `waitForNavigation` option.
|
|
7987
7985
|
*
|
|
@@ -7999,7 +7997,7 @@ declare namespace CodeceptJS {
|
|
|
7999
7997
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
8000
7998
|
* @returns automatically synchronized promise through #recorder
|
|
8001
7999
|
*/
|
|
8002
|
-
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
8000
|
+
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
8003
8001
|
/**
|
|
8004
8002
|
* Grab the data from performance timing using Navigation Timing API.
|
|
8005
8003
|
* The returned data will contain following things in ms:
|
|
@@ -8022,7 +8020,7 @@ declare namespace CodeceptJS {
|
|
|
8022
8020
|
* ```
|
|
8023
8021
|
* @returns automatically synchronized promise through #recorder
|
|
8024
8022
|
*/
|
|
8025
|
-
grabDataFromPerformanceTiming():
|
|
8023
|
+
grabDataFromPerformanceTiming(): void;
|
|
8026
8024
|
/**
|
|
8027
8025
|
* Grab the width, height, location of given locator.
|
|
8028
8026
|
* Provide `width` or `height`as second param to get your desired prop.
|
|
@@ -8311,7 +8309,7 @@ declare namespace CodeceptJS {
|
|
|
8311
8309
|
* @param url - url path or global url.
|
|
8312
8310
|
* @returns automatically synchronized promise through #recorder
|
|
8313
8311
|
*/
|
|
8314
|
-
amOnPage(url: string):
|
|
8312
|
+
amOnPage(url: string): void;
|
|
8315
8313
|
/**
|
|
8316
8314
|
* Resize the current window to provided width and height.
|
|
8317
8315
|
* First parameter can be set to `maximize`.
|
|
@@ -8319,7 +8317,7 @@ declare namespace CodeceptJS {
|
|
|
8319
8317
|
* @param height - height in pixels.
|
|
8320
8318
|
* @returns automatically synchronized promise through #recorder
|
|
8321
8319
|
*/
|
|
8322
|
-
resizeWindow(width: number, height: number):
|
|
8320
|
+
resizeWindow(width: number, height: number): void;
|
|
8323
8321
|
/**
|
|
8324
8322
|
* Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
|
|
8325
8323
|
*
|
|
@@ -8334,7 +8332,7 @@ declare namespace CodeceptJS {
|
|
|
8334
8332
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
|
|
8335
8333
|
* @returns automatically synchronized promise through #recorder
|
|
8336
8334
|
*/
|
|
8337
|
-
focus(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
8335
|
+
focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
8338
8336
|
/**
|
|
8339
8337
|
* Remove focus from a text input, button, etc.
|
|
8340
8338
|
* Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
|
|
@@ -8354,7 +8352,7 @@ declare namespace CodeceptJS {
|
|
|
8354
8352
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
|
|
8355
8353
|
* @returns automatically synchronized promise through #recorder
|
|
8356
8354
|
*/
|
|
8357
|
-
blur(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
8355
|
+
blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
8358
8356
|
/**
|
|
8359
8357
|
* Perform a click on a link or a button, given by a locator.
|
|
8360
8358
|
* If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
|
|
@@ -8381,7 +8379,7 @@ declare namespace CodeceptJS {
|
|
|
8381
8379
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
8382
8380
|
* @returns automatically synchronized promise through #recorder
|
|
8383
8381
|
*/
|
|
8384
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null):
|
|
8382
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
|
|
8385
8383
|
/**
|
|
8386
8384
|
* Reload the current page.
|
|
8387
8385
|
*
|
|
@@ -8390,7 +8388,7 @@ declare namespace CodeceptJS {
|
|
|
8390
8388
|
* ```
|
|
8391
8389
|
* @returns automatically synchronized promise through #recorder
|
|
8392
8390
|
*/
|
|
8393
|
-
refreshPage():
|
|
8391
|
+
refreshPage(): void;
|
|
8394
8392
|
/**
|
|
8395
8393
|
* Waits for an element to become visible on a page (by default waits for 1sec).
|
|
8396
8394
|
* Element can be located by CSS or XPath.
|
|
@@ -8402,7 +8400,7 @@ declare namespace CodeceptJS {
|
|
|
8402
8400
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
8403
8401
|
* @returns automatically synchronized promise through #recorder
|
|
8404
8402
|
*/
|
|
8405
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
8403
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
8406
8404
|
/**
|
|
8407
8405
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
8408
8406
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -8421,7 +8419,7 @@ declare namespace CodeceptJS {
|
|
|
8421
8419
|
* @param value - text value to fill.
|
|
8422
8420
|
* @returns automatically synchronized promise through #recorder
|
|
8423
8421
|
*/
|
|
8424
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
8422
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
8425
8423
|
/**
|
|
8426
8424
|
* Clears a `<textarea>` or text `<input>` element's value.
|
|
8427
8425
|
*
|
|
@@ -8433,7 +8431,7 @@ declare namespace CodeceptJS {
|
|
|
8433
8431
|
* @param editable - field located by label|name|CSS|XPath|strict locator.
|
|
8434
8432
|
* @returns automatically synchronized promise through #recorder.
|
|
8435
8433
|
*/
|
|
8436
|
-
clearField(editable: LocatorOrString):
|
|
8434
|
+
clearField(editable: LocatorOrString): void;
|
|
8437
8435
|
/**
|
|
8438
8436
|
* Appends text to a input field or textarea.
|
|
8439
8437
|
* Field is located by name, label, CSS or XPath
|
|
@@ -8447,7 +8445,7 @@ declare namespace CodeceptJS {
|
|
|
8447
8445
|
* @param value - text value to append.
|
|
8448
8446
|
* @returns automatically synchronized promise through #recorder
|
|
8449
8447
|
*/
|
|
8450
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
8448
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
8451
8449
|
/**
|
|
8452
8450
|
* Attaches a file to element located by label, name, CSS or XPath
|
|
8453
8451
|
* Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
@@ -8461,7 +8459,7 @@ declare namespace CodeceptJS {
|
|
|
8461
8459
|
* @param pathToFile - local file path relative to codecept.conf.ts or codecept.conf.js config file.
|
|
8462
8460
|
* @returns automatically synchronized promise through #recorder
|
|
8463
8461
|
*/
|
|
8464
|
-
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string):
|
|
8462
|
+
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
|
|
8465
8463
|
/**
|
|
8466
8464
|
* Presses a key on a focused element.
|
|
8467
8465
|
* Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
|
|
@@ -8478,7 +8476,7 @@ declare namespace CodeceptJS {
|
|
|
8478
8476
|
*
|
|
8479
8477
|
* {{ keys }}
|
|
8480
8478
|
*/
|
|
8481
|
-
pressKey(key: string | string[]):
|
|
8479
|
+
pressKey(key: string | string[]): void;
|
|
8482
8480
|
/**
|
|
8483
8481
|
* Moves cursor to element matched by locator.
|
|
8484
8482
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -8492,7 +8490,7 @@ declare namespace CodeceptJS {
|
|
|
8492
8490
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
8493
8491
|
* @returns automatically synchronized promise through #recorder
|
|
8494
8492
|
*/
|
|
8495
|
-
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
8493
|
+
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
8496
8494
|
/**
|
|
8497
8495
|
* Performs a double-click on an element matched by link|button|label|CSS or XPath.
|
|
8498
8496
|
* Context can be specified as second parameter to narrow search.
|
|
@@ -8507,7 +8505,7 @@ declare namespace CodeceptJS {
|
|
|
8507
8505
|
* @param [context = null] - (optional, `null` by default) element to search in CSS|XPath|Strict locator.
|
|
8508
8506
|
* @returns automatically synchronized promise through #recorder
|
|
8509
8507
|
*/
|
|
8510
|
-
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
8508
|
+
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
8511
8509
|
/**
|
|
8512
8510
|
* Performs right click on a clickable element matched by semantic locator, CSS or XPath.
|
|
8513
8511
|
*
|
|
@@ -8523,7 +8521,7 @@ declare namespace CodeceptJS {
|
|
|
8523
8521
|
* @param [context = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
8524
8522
|
* @returns automatically synchronized promise through #recorder
|
|
8525
8523
|
*/
|
|
8526
|
-
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
8524
|
+
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
8527
8525
|
/**
|
|
8528
8526
|
* Selects a checkbox or radio button.
|
|
8529
8527
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -8539,7 +8537,7 @@ declare namespace CodeceptJS {
|
|
|
8539
8537
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
8540
8538
|
* @returns automatically synchronized promise through #recorder
|
|
8541
8539
|
*/
|
|
8542
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
8540
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
8543
8541
|
/**
|
|
8544
8542
|
* Unselects a checkbox or radio button.
|
|
8545
8543
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -8555,7 +8553,7 @@ declare namespace CodeceptJS {
|
|
|
8555
8553
|
* @param [context = null] - (optional, `null` by default) element located by CSS | XPath | strict locator.
|
|
8556
8554
|
* @returns automatically synchronized promise through #recorder
|
|
8557
8555
|
*/
|
|
8558
|
-
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
8556
|
+
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
8559
8557
|
/**
|
|
8560
8558
|
* Verifies that the specified checkbox is checked.
|
|
8561
8559
|
*
|
|
@@ -8567,7 +8565,7 @@ declare namespace CodeceptJS {
|
|
|
8567
8565
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
8568
8566
|
* @returns automatically synchronized promise through #recorder
|
|
8569
8567
|
*/
|
|
8570
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
8568
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
8571
8569
|
/**
|
|
8572
8570
|
* Verifies that the specified checkbox is not checked.
|
|
8573
8571
|
*
|
|
@@ -8579,7 +8577,7 @@ declare namespace CodeceptJS {
|
|
|
8579
8577
|
* @param field - located by label|name|CSS|XPath|strict locator.
|
|
8580
8578
|
* @returns automatically synchronized promise through #recorder
|
|
8581
8579
|
*/
|
|
8582
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
8580
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
8583
8581
|
/**
|
|
8584
8582
|
* Selects an option in a drop-down select.
|
|
8585
8583
|
* Field is searched by label | name | CSS | XPath.
|
|
@@ -8603,7 +8601,7 @@ declare namespace CodeceptJS {
|
|
|
8603
8601
|
* @param option - visible text or value of option.
|
|
8604
8602
|
* @returns automatically synchronized promise through #recorder
|
|
8605
8603
|
*/
|
|
8606
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
8604
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
8607
8605
|
/**
|
|
8608
8606
|
* Checks that current url contains a provided fragment.
|
|
8609
8607
|
*
|
|
@@ -8613,13 +8611,13 @@ declare namespace CodeceptJS {
|
|
|
8613
8611
|
* @param url - a fragment to check
|
|
8614
8612
|
* @returns automatically synchronized promise through #recorder
|
|
8615
8613
|
*/
|
|
8616
|
-
seeInCurrentUrl(url: string):
|
|
8614
|
+
seeInCurrentUrl(url: string): void;
|
|
8617
8615
|
/**
|
|
8618
8616
|
* Checks that current url does not contain a provided fragment.
|
|
8619
8617
|
* @param url - value to check.
|
|
8620
8618
|
* @returns automatically synchronized promise through #recorder
|
|
8621
8619
|
*/
|
|
8622
|
-
dontSeeInCurrentUrl(url: string):
|
|
8620
|
+
dontSeeInCurrentUrl(url: string): void;
|
|
8623
8621
|
/**
|
|
8624
8622
|
* Checks that current url is equal to provided one.
|
|
8625
8623
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -8632,7 +8630,7 @@ declare namespace CodeceptJS {
|
|
|
8632
8630
|
* @param url - value to check.
|
|
8633
8631
|
* @returns automatically synchronized promise through #recorder
|
|
8634
8632
|
*/
|
|
8635
|
-
seeCurrentUrlEquals(url: string):
|
|
8633
|
+
seeCurrentUrlEquals(url: string): void;
|
|
8636
8634
|
/**
|
|
8637
8635
|
* Checks that current url is not equal to provided one.
|
|
8638
8636
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -8644,7 +8642,7 @@ declare namespace CodeceptJS {
|
|
|
8644
8642
|
* @param url - value to check.
|
|
8645
8643
|
* @returns automatically synchronized promise through #recorder
|
|
8646
8644
|
*/
|
|
8647
|
-
dontSeeCurrentUrlEquals(url: string):
|
|
8645
|
+
dontSeeCurrentUrlEquals(url: string): void;
|
|
8648
8646
|
/**
|
|
8649
8647
|
* Checks that a page contains a visible text.
|
|
8650
8648
|
* Use context parameter to narrow down the search.
|
|
@@ -8658,7 +8656,7 @@ declare namespace CodeceptJS {
|
|
|
8658
8656
|
* @param [context = null] - (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
|
|
8659
8657
|
* @returns automatically synchronized promise through #recorder
|
|
8660
8658
|
*/
|
|
8661
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
8659
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
8662
8660
|
/**
|
|
8663
8661
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
8664
8662
|
* Use context parameter to narrow down the search.
|
|
@@ -8671,7 +8669,7 @@ declare namespace CodeceptJS {
|
|
|
8671
8669
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator in which to perfrom search.
|
|
8672
8670
|
* @returns automatically synchronized promise through #recorder
|
|
8673
8671
|
*/
|
|
8674
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
8672
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
8675
8673
|
/**
|
|
8676
8674
|
* Checks that a given Element is visible
|
|
8677
8675
|
* Element is located by CSS or XPath.
|
|
@@ -8682,7 +8680,7 @@ declare namespace CodeceptJS {
|
|
|
8682
8680
|
* @param locator - located by CSS|XPath|strict locator.
|
|
8683
8681
|
* @returns automatically synchronized promise through #recorder
|
|
8684
8682
|
*/
|
|
8685
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
8683
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
8686
8684
|
/**
|
|
8687
8685
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
8688
8686
|
*
|
|
@@ -8692,7 +8690,7 @@ declare namespace CodeceptJS {
|
|
|
8692
8690
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
8693
8691
|
* @returns automatically synchronized promise through #recorder
|
|
8694
8692
|
*/
|
|
8695
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
8693
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
8696
8694
|
/**
|
|
8697
8695
|
* Checks that a given Element is present in the DOM
|
|
8698
8696
|
* Element is located by CSS or XPath.
|
|
@@ -8703,7 +8701,7 @@ declare namespace CodeceptJS {
|
|
|
8703
8701
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
8704
8702
|
* @returns automatically synchronized promise through #recorder
|
|
8705
8703
|
*/
|
|
8706
|
-
seeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
8704
|
+
seeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
8707
8705
|
/**
|
|
8708
8706
|
* Opposite to `seeElementInDOM`. Checks that element is not on page.
|
|
8709
8707
|
*
|
|
@@ -8713,7 +8711,7 @@ declare namespace CodeceptJS {
|
|
|
8713
8711
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
8714
8712
|
* @returns automatically synchronized promise through #recorder
|
|
8715
8713
|
*/
|
|
8716
|
-
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
8714
|
+
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
8717
8715
|
/**
|
|
8718
8716
|
* Asserts that an element is visible a given number of times.
|
|
8719
8717
|
* Element is located by CSS or XPath.
|
|
@@ -8725,7 +8723,7 @@ declare namespace CodeceptJS {
|
|
|
8725
8723
|
* @param num - number of elements.
|
|
8726
8724
|
* @returns automatically synchronized promise through #recorder
|
|
8727
8725
|
*/
|
|
8728
|
-
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
8726
|
+
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
8729
8727
|
/**
|
|
8730
8728
|
* Grab number of visible elements by locator.
|
|
8731
8729
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -8751,7 +8749,7 @@ declare namespace CodeceptJS {
|
|
|
8751
8749
|
* @param value - value to check.
|
|
8752
8750
|
* @returns automatically synchronized promise through #recorder
|
|
8753
8751
|
*/
|
|
8754
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
8752
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
8755
8753
|
/**
|
|
8756
8754
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
8757
8755
|
* Opposite to `seeInField`.
|
|
@@ -8764,7 +8762,7 @@ declare namespace CodeceptJS {
|
|
|
8764
8762
|
* @param value - value to check.
|
|
8765
8763
|
* @returns automatically synchronized promise through #recorder
|
|
8766
8764
|
*/
|
|
8767
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
8765
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
8768
8766
|
/**
|
|
8769
8767
|
* Checks that text is equal to provided one.
|
|
8770
8768
|
*
|
|
@@ -8782,7 +8780,7 @@ declare namespace CodeceptJS {
|
|
|
8782
8780
|
* @param text - value to check.
|
|
8783
8781
|
* @returns automatically synchronized promise through #recorder
|
|
8784
8782
|
*/
|
|
8785
|
-
seeInSource(text: string):
|
|
8783
|
+
seeInSource(text: string): void;
|
|
8786
8784
|
/**
|
|
8787
8785
|
* Checks that the current page does not contains the given string in its raw source code.
|
|
8788
8786
|
*
|
|
@@ -8792,7 +8790,7 @@ declare namespace CodeceptJS {
|
|
|
8792
8790
|
* @param value - to check.
|
|
8793
8791
|
* @returns automatically synchronized promise through #recorder
|
|
8794
8792
|
*/
|
|
8795
|
-
dontSeeInSource(value: string):
|
|
8793
|
+
dontSeeInSource(value: string): void;
|
|
8796
8794
|
/**
|
|
8797
8795
|
* Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
8798
8796
|
* Filename is relative to output folder.
|
|
@@ -8804,7 +8802,7 @@ declare namespace CodeceptJS {
|
|
|
8804
8802
|
* @param fileName - file name to save.
|
|
8805
8803
|
* @returns automatically synchronized promise through #recorder
|
|
8806
8804
|
*/
|
|
8807
|
-
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string):
|
|
8805
|
+
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): void;
|
|
8808
8806
|
/**
|
|
8809
8807
|
* Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
8810
8808
|
* Filename is relative to output folder.
|
|
@@ -8818,7 +8816,7 @@ declare namespace CodeceptJS {
|
|
|
8818
8816
|
* @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
8819
8817
|
* @returns automatically synchronized promise through #recorder
|
|
8820
8818
|
*/
|
|
8821
|
-
saveScreenshot(fileName: string, fullPage?: boolean):
|
|
8819
|
+
saveScreenshot(fileName: string, fullPage?: boolean): void;
|
|
8822
8820
|
/**
|
|
8823
8821
|
* Pauses execution for a number of seconds.
|
|
8824
8822
|
*
|
|
@@ -8828,7 +8826,7 @@ declare namespace CodeceptJS {
|
|
|
8828
8826
|
* @param sec - number of second to wait.
|
|
8829
8827
|
* @returns automatically synchronized promise through #recorder
|
|
8830
8828
|
*/
|
|
8831
|
-
wait(sec: number):
|
|
8829
|
+
wait(sec: number): void;
|
|
8832
8830
|
/**
|
|
8833
8831
|
* Executes sync script on a page.
|
|
8834
8832
|
* Pass arguments to function as additional parameters.
|
|
@@ -8980,7 +8978,7 @@ declare namespace CodeceptJS {
|
|
|
8980
8978
|
* ```
|
|
8981
8979
|
* @returns automatically synchronized promise through #recorder
|
|
8982
8980
|
*/
|
|
8983
|
-
scrollPageToTop():
|
|
8981
|
+
scrollPageToTop(): void;
|
|
8984
8982
|
/**
|
|
8985
8983
|
* Scroll page to the bottom.
|
|
8986
8984
|
*
|
|
@@ -8989,7 +8987,7 @@ declare namespace CodeceptJS {
|
|
|
8989
8987
|
* ```
|
|
8990
8988
|
* @returns automatically synchronized promise through #recorder
|
|
8991
8989
|
*/
|
|
8992
|
-
scrollPageToBottom():
|
|
8990
|
+
scrollPageToBottom(): void;
|
|
8993
8991
|
/**
|
|
8994
8992
|
* Scrolls to element matched by locator.
|
|
8995
8993
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -9003,7 +9001,7 @@ declare namespace CodeceptJS {
|
|
|
9003
9001
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
9004
9002
|
* @returns automatically synchronized promise through #recorder
|
|
9005
9003
|
*/
|
|
9006
|
-
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
9004
|
+
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
9007
9005
|
/**
|
|
9008
9006
|
* Switches frame or in case of null locator reverts to parent.
|
|
9009
9007
|
*
|
|
@@ -9014,7 +9012,7 @@ declare namespace CodeceptJS {
|
|
|
9014
9012
|
* @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
9015
9013
|
* @returns automatically synchronized promise through #recorder
|
|
9016
9014
|
*/
|
|
9017
|
-
switchTo(locator?: CodeceptJS.LocatorOrString):
|
|
9015
|
+
switchTo(locator?: CodeceptJS.LocatorOrString): void;
|
|
9018
9016
|
/**
|
|
9019
9017
|
* Sets cookie(s).
|
|
9020
9018
|
*
|
|
@@ -9032,7 +9030,7 @@ declare namespace CodeceptJS {
|
|
|
9032
9030
|
* @param cookie - a cookie object or array of cookie objects.
|
|
9033
9031
|
* @returns automatically synchronized promise through #recorder
|
|
9034
9032
|
*/
|
|
9035
|
-
setCookie(cookie: Cookie | Cookie[]):
|
|
9033
|
+
setCookie(cookie: Cookie | Cookie[]): void;
|
|
9036
9034
|
/**
|
|
9037
9035
|
* Checks that cookie with given name exists.
|
|
9038
9036
|
*
|
|
@@ -9042,7 +9040,7 @@ declare namespace CodeceptJS {
|
|
|
9042
9040
|
* @param name - cookie name.
|
|
9043
9041
|
* @returns automatically synchronized promise through #recorder
|
|
9044
9042
|
*/
|
|
9045
|
-
seeCookie(name: string):
|
|
9043
|
+
seeCookie(name: string): void;
|
|
9046
9044
|
/**
|
|
9047
9045
|
* Checks that cookie with given name does not exist.
|
|
9048
9046
|
*
|
|
@@ -9052,7 +9050,7 @@ declare namespace CodeceptJS {
|
|
|
9052
9050
|
* @param name - cookie name.
|
|
9053
9051
|
* @returns automatically synchronized promise through #recorder
|
|
9054
9052
|
*/
|
|
9055
|
-
dontSeeCookie(name: string):
|
|
9053
|
+
dontSeeCookie(name: string): void;
|
|
9056
9054
|
/**
|
|
9057
9055
|
* Gets a cookie object by name.
|
|
9058
9056
|
* If none provided gets all cookies.
|
|
@@ -9075,12 +9073,11 @@ declare namespace CodeceptJS {
|
|
|
9075
9073
|
*
|
|
9076
9074
|
* ```js
|
|
9077
9075
|
* I.clearCookie();
|
|
9078
|
-
* I.clearCookie('test');
|
|
9076
|
+
* I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
|
|
9079
9077
|
* ```
|
|
9080
9078
|
* @param [cookie = null] - (optional, `null` by default) cookie name
|
|
9081
|
-
* @returns automatically synchronized promise through #recorder
|
|
9082
9079
|
*/
|
|
9083
|
-
clearCookie(cookie?: string):
|
|
9080
|
+
clearCookie(cookie?: string): void;
|
|
9084
9081
|
/**
|
|
9085
9082
|
* Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
|
|
9086
9083
|
*
|
|
@@ -9091,7 +9088,7 @@ declare namespace CodeceptJS {
|
|
|
9091
9088
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
9092
9089
|
* @returns automatically synchronized promise through #recorder
|
|
9093
9090
|
*/
|
|
9094
|
-
waitInUrl(urlPart: string, sec?: number):
|
|
9091
|
+
waitInUrl(urlPart: string, sec?: number): void;
|
|
9095
9092
|
/**
|
|
9096
9093
|
* Waits for the entire URL to match the expected
|
|
9097
9094
|
*
|
|
@@ -9103,7 +9100,7 @@ declare namespace CodeceptJS {
|
|
|
9103
9100
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
9104
9101
|
* @returns automatically synchronized promise through #recorder
|
|
9105
9102
|
*/
|
|
9106
|
-
waitUrlEquals(urlPart: string, sec?: number):
|
|
9103
|
+
waitUrlEquals(urlPart: string, sec?: number): void;
|
|
9107
9104
|
/**
|
|
9108
9105
|
* Waits for a function to return true (waits for 1 sec by default).
|
|
9109
9106
|
* Running in browser context.
|
|
@@ -9122,7 +9119,7 @@ declare namespace CodeceptJS {
|
|
|
9122
9119
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
9123
9120
|
* @returns automatically synchronized promise through #recorder
|
|
9124
9121
|
*/
|
|
9125
|
-
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number):
|
|
9122
|
+
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
|
|
9126
9123
|
/**
|
|
9127
9124
|
* Waits for a specified number of elements on the page.
|
|
9128
9125
|
*
|
|
@@ -9134,7 +9131,7 @@ declare namespace CodeceptJS {
|
|
|
9134
9131
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
9135
9132
|
* @returns automatically synchronized promise through #recorder
|
|
9136
9133
|
*/
|
|
9137
|
-
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number):
|
|
9134
|
+
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): void;
|
|
9138
9135
|
/**
|
|
9139
9136
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
9140
9137
|
* Element can be located by CSS or XPath.
|
|
@@ -9147,7 +9144,7 @@ declare namespace CodeceptJS {
|
|
|
9147
9144
|
* @param [sec] - (optional, `1` by default) time in seconds to wait
|
|
9148
9145
|
* @returns automatically synchronized promise through #recorder
|
|
9149
9146
|
*/
|
|
9150
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
9147
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
9151
9148
|
/**
|
|
9152
9149
|
* Waits for an element to hide (by default waits for 1sec).
|
|
9153
9150
|
* Element can be located by CSS or XPath.
|
|
@@ -9159,7 +9156,7 @@ declare namespace CodeceptJS {
|
|
|
9159
9156
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
9160
9157
|
* @returns automatically synchronized promise through #recorder
|
|
9161
9158
|
*/
|
|
9162
|
-
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
9159
|
+
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
9163
9160
|
/**
|
|
9164
9161
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
9165
9162
|
* Element can be located by CSS or XPath.
|
|
@@ -9171,7 +9168,7 @@ declare namespace CodeceptJS {
|
|
|
9171
9168
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
9172
9169
|
* @returns automatically synchronized promise through #recorder
|
|
9173
9170
|
*/
|
|
9174
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
9171
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
9175
9172
|
/**
|
|
9176
9173
|
* Waits for a text to appear (by default waits for 1sec).
|
|
9177
9174
|
* Element can be located by CSS or XPath.
|
|
@@ -9186,7 +9183,7 @@ declare namespace CodeceptJS {
|
|
|
9186
9183
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
9187
9184
|
* @returns automatically synchronized promise through #recorder
|
|
9188
9185
|
*/
|
|
9189
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
9186
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
9190
9187
|
}
|
|
9191
9188
|
/**
|
|
9192
9189
|
* ## Configuration
|
|
@@ -9647,7 +9644,7 @@ declare namespace CodeceptJS {
|
|
|
9647
9644
|
* @param url - url path or global url.
|
|
9648
9645
|
* @returns automatically synchronized promise through #recorder
|
|
9649
9646
|
*/
|
|
9650
|
-
amOnPage(url: string):
|
|
9647
|
+
amOnPage(url: string): void;
|
|
9651
9648
|
/**
|
|
9652
9649
|
* Perform a click on a link or a button, given by a locator.
|
|
9653
9650
|
* If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
|
|
@@ -9677,7 +9674,7 @@ declare namespace CodeceptJS {
|
|
|
9677
9674
|
*
|
|
9678
9675
|
* {{ react }}
|
|
9679
9676
|
*/
|
|
9680
|
-
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null):
|
|
9677
|
+
click(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString | null): void;
|
|
9681
9678
|
/**
|
|
9682
9679
|
* Perform an emulated click on a link or a button, given by a locator.
|
|
9683
9680
|
* Unlike normal click instead of sending native event, emulates a click with JavaScript.
|
|
@@ -9710,7 +9707,7 @@ declare namespace CodeceptJS {
|
|
|
9710
9707
|
*
|
|
9711
9708
|
* {{ react }}
|
|
9712
9709
|
*/
|
|
9713
|
-
forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
9710
|
+
forceClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
9714
9711
|
/**
|
|
9715
9712
|
* Performs a double-click on an element matched by link|button|label|CSS or XPath.
|
|
9716
9713
|
* Context can be specified as second parameter to narrow search.
|
|
@@ -9728,7 +9725,7 @@ declare namespace CodeceptJS {
|
|
|
9728
9725
|
*
|
|
9729
9726
|
* {{ react }}
|
|
9730
9727
|
*/
|
|
9731
|
-
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
9728
|
+
doubleClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
9732
9729
|
/**
|
|
9733
9730
|
* Performs right click on a clickable element matched by semantic locator, CSS or XPath.
|
|
9734
9731
|
*
|
|
@@ -9747,7 +9744,7 @@ declare namespace CodeceptJS {
|
|
|
9747
9744
|
*
|
|
9748
9745
|
* {{ react }}
|
|
9749
9746
|
*/
|
|
9750
|
-
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
9747
|
+
rightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
9751
9748
|
/**
|
|
9752
9749
|
* Emulates right click on an element.
|
|
9753
9750
|
* Unlike normal click instead of sending native event, emulates a click with JavaScript.
|
|
@@ -9770,7 +9767,7 @@ declare namespace CodeceptJS {
|
|
|
9770
9767
|
*
|
|
9771
9768
|
* {{ react }}
|
|
9772
9769
|
*/
|
|
9773
|
-
forceRightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
9770
|
+
forceRightClick(locator: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
9774
9771
|
/**
|
|
9775
9772
|
* Fills a text field or textarea, after clearing its value, with the given string.
|
|
9776
9773
|
* Field is located by name, label, CSS, or XPath.
|
|
@@ -9792,7 +9789,7 @@ declare namespace CodeceptJS {
|
|
|
9792
9789
|
* {{ react }}
|
|
9793
9790
|
* {{ custom }}
|
|
9794
9791
|
*/
|
|
9795
|
-
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
9792
|
+
fillField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
9796
9793
|
/**
|
|
9797
9794
|
* Appends text to a input field or textarea.
|
|
9798
9795
|
* Field is located by name, label, CSS or XPath
|
|
@@ -9808,7 +9805,7 @@ declare namespace CodeceptJS {
|
|
|
9808
9805
|
*
|
|
9809
9806
|
* {{ react }}
|
|
9810
9807
|
*/
|
|
9811
|
-
appendField(field: CodeceptJS.LocatorOrString, value: string):
|
|
9808
|
+
appendField(field: CodeceptJS.LocatorOrString, value: string): void;
|
|
9812
9809
|
/**
|
|
9813
9810
|
* Clears a `<textarea>` or text `<input>` element's value.
|
|
9814
9811
|
*
|
|
@@ -9820,7 +9817,7 @@ declare namespace CodeceptJS {
|
|
|
9820
9817
|
* @param editable - field located by label|name|CSS|XPath|strict locator.
|
|
9821
9818
|
* @returns automatically synchronized promise through #recorder.
|
|
9822
9819
|
*/
|
|
9823
|
-
clearField(editable: LocatorOrString):
|
|
9820
|
+
clearField(editable: LocatorOrString): void;
|
|
9824
9821
|
/**
|
|
9825
9822
|
* Selects an option in a drop-down select.
|
|
9826
9823
|
* Field is searched by label | name | CSS | XPath.
|
|
@@ -9844,7 +9841,7 @@ declare namespace CodeceptJS {
|
|
|
9844
9841
|
* @param option - visible text or value of option.
|
|
9845
9842
|
* @returns automatically synchronized promise through #recorder
|
|
9846
9843
|
*/
|
|
9847
|
-
selectOption(select: LocatorOrString, option: string | any[]):
|
|
9844
|
+
selectOption(select: LocatorOrString, option: string | any[]): void;
|
|
9848
9845
|
/**
|
|
9849
9846
|
* Attaches a file to element located by label, name, CSS or XPath
|
|
9850
9847
|
* Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
|
|
@@ -9860,7 +9857,7 @@ declare namespace CodeceptJS {
|
|
|
9860
9857
|
*
|
|
9861
9858
|
* Appium: not tested
|
|
9862
9859
|
*/
|
|
9863
|
-
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string):
|
|
9860
|
+
attachFile(locator: CodeceptJS.LocatorOrString, pathToFile: string): void;
|
|
9864
9861
|
/**
|
|
9865
9862
|
* Selects a checkbox or radio button.
|
|
9866
9863
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -9878,7 +9875,7 @@ declare namespace CodeceptJS {
|
|
|
9878
9875
|
*
|
|
9879
9876
|
* Appium: not tested
|
|
9880
9877
|
*/
|
|
9881
|
-
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
9878
|
+
checkOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
9882
9879
|
/**
|
|
9883
9880
|
* Unselects a checkbox or radio button.
|
|
9884
9881
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -9896,7 +9893,7 @@ declare namespace CodeceptJS {
|
|
|
9896
9893
|
*
|
|
9897
9894
|
* Appium: not tested
|
|
9898
9895
|
*/
|
|
9899
|
-
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString):
|
|
9896
|
+
uncheckOption(field: CodeceptJS.LocatorOrString, context?: CodeceptJS.LocatorOrString): void;
|
|
9900
9897
|
/**
|
|
9901
9898
|
* Retrieves all texts from an element located by CSS or XPath and returns it to test.
|
|
9902
9899
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -10025,7 +10022,7 @@ declare namespace CodeceptJS {
|
|
|
10025
10022
|
* @param text - text value to check.
|
|
10026
10023
|
* @returns automatically synchronized promise through #recorder
|
|
10027
10024
|
*/
|
|
10028
|
-
seeInTitle(text: string):
|
|
10025
|
+
seeInTitle(text: string): void;
|
|
10029
10026
|
/**
|
|
10030
10027
|
* Checks that title is equal to provided one.
|
|
10031
10028
|
*
|
|
@@ -10035,7 +10032,7 @@ declare namespace CodeceptJS {
|
|
|
10035
10032
|
* @param text - value to check.
|
|
10036
10033
|
* @returns automatically synchronized promise through #recorder
|
|
10037
10034
|
*/
|
|
10038
|
-
seeTitleEquals(text: string):
|
|
10035
|
+
seeTitleEquals(text: string): void;
|
|
10039
10036
|
/**
|
|
10040
10037
|
* Checks that title does not contain text.
|
|
10041
10038
|
*
|
|
@@ -10045,7 +10042,7 @@ declare namespace CodeceptJS {
|
|
|
10045
10042
|
* @param text - value to check.
|
|
10046
10043
|
* @returns automatically synchronized promise through #recorder
|
|
10047
10044
|
*/
|
|
10048
|
-
dontSeeInTitle(text: string):
|
|
10045
|
+
dontSeeInTitle(text: string): void;
|
|
10049
10046
|
/**
|
|
10050
10047
|
* Retrieves a page title and returns it to test.
|
|
10051
10048
|
* Resumes test execution, so **should be used inside async with `await`** operator.
|
|
@@ -10072,7 +10069,7 @@ declare namespace CodeceptJS {
|
|
|
10072
10069
|
*
|
|
10073
10070
|
* {{ react }}
|
|
10074
10071
|
*/
|
|
10075
|
-
see(text: string, context?: CodeceptJS.LocatorOrString):
|
|
10072
|
+
see(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
10076
10073
|
/**
|
|
10077
10074
|
* Checks that text is equal to provided one.
|
|
10078
10075
|
*
|
|
@@ -10083,7 +10080,7 @@ declare namespace CodeceptJS {
|
|
|
10083
10080
|
* @param [context = null] - element located by CSS|XPath|strict locator.
|
|
10084
10081
|
* @returns automatically synchronized promise through #recorder
|
|
10085
10082
|
*/
|
|
10086
|
-
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString):
|
|
10083
|
+
seeTextEquals(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
10087
10084
|
/**
|
|
10088
10085
|
* Opposite to `see`. Checks that a text is not present on a page.
|
|
10089
10086
|
* Use context parameter to narrow down the search.
|
|
@@ -10099,7 +10096,7 @@ declare namespace CodeceptJS {
|
|
|
10099
10096
|
*
|
|
10100
10097
|
* {{ react }}
|
|
10101
10098
|
*/
|
|
10102
|
-
dontSee(text: string, context?: CodeceptJS.LocatorOrString):
|
|
10099
|
+
dontSee(text: string, context?: CodeceptJS.LocatorOrString): void;
|
|
10103
10100
|
/**
|
|
10104
10101
|
* Checks that the given input field or textarea equals to given value.
|
|
10105
10102
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -10114,7 +10111,7 @@ declare namespace CodeceptJS {
|
|
|
10114
10111
|
* @param value - value to check.
|
|
10115
10112
|
* @returns automatically synchronized promise through #recorder
|
|
10116
10113
|
*/
|
|
10117
|
-
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
10114
|
+
seeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
10118
10115
|
/**
|
|
10119
10116
|
* Checks that value of input field or textarea doesn't equal to given value
|
|
10120
10117
|
* Opposite to `seeInField`.
|
|
@@ -10127,7 +10124,7 @@ declare namespace CodeceptJS {
|
|
|
10127
10124
|
* @param value - value to check.
|
|
10128
10125
|
* @returns automatically synchronized promise through #recorder
|
|
10129
10126
|
*/
|
|
10130
|
-
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret):
|
|
10127
|
+
dontSeeInField(field: CodeceptJS.LocatorOrString, value: CodeceptJS.StringOrSecret): void;
|
|
10131
10128
|
/**
|
|
10132
10129
|
* Verifies that the specified checkbox is checked.
|
|
10133
10130
|
*
|
|
@@ -10141,7 +10138,7 @@ declare namespace CodeceptJS {
|
|
|
10141
10138
|
*
|
|
10142
10139
|
* Appium: not tested
|
|
10143
10140
|
*/
|
|
10144
|
-
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
10141
|
+
seeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
10145
10142
|
/**
|
|
10146
10143
|
* Verifies that the specified checkbox is not checked.
|
|
10147
10144
|
*
|
|
@@ -10155,7 +10152,7 @@ declare namespace CodeceptJS {
|
|
|
10155
10152
|
*
|
|
10156
10153
|
* Appium: not tested
|
|
10157
10154
|
*/
|
|
10158
|
-
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString):
|
|
10155
|
+
dontSeeCheckboxIsChecked(field: CodeceptJS.LocatorOrString): void;
|
|
10159
10156
|
/**
|
|
10160
10157
|
* Checks that a given Element is visible
|
|
10161
10158
|
* Element is located by CSS or XPath.
|
|
@@ -10168,7 +10165,7 @@ declare namespace CodeceptJS {
|
|
|
10168
10165
|
*
|
|
10169
10166
|
* {{ react }}
|
|
10170
10167
|
*/
|
|
10171
|
-
seeElement(locator: CodeceptJS.LocatorOrString):
|
|
10168
|
+
seeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
10172
10169
|
/**
|
|
10173
10170
|
* Opposite to `seeElement`. Checks that element is not visible (or in DOM)
|
|
10174
10171
|
*
|
|
@@ -10180,7 +10177,7 @@ declare namespace CodeceptJS {
|
|
|
10180
10177
|
*
|
|
10181
10178
|
* {{ react }}
|
|
10182
10179
|
*/
|
|
10183
|
-
dontSeeElement(locator: CodeceptJS.LocatorOrString):
|
|
10180
|
+
dontSeeElement(locator: CodeceptJS.LocatorOrString): void;
|
|
10184
10181
|
/**
|
|
10185
10182
|
* Checks that a given Element is present in the DOM
|
|
10186
10183
|
* Element is located by CSS or XPath.
|
|
@@ -10191,7 +10188,7 @@ declare namespace CodeceptJS {
|
|
|
10191
10188
|
* @param locator - element located by CSS|XPath|strict locator.
|
|
10192
10189
|
* @returns automatically synchronized promise through #recorder
|
|
10193
10190
|
*/
|
|
10194
|
-
seeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
10191
|
+
seeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
10195
10192
|
/**
|
|
10196
10193
|
* Opposite to `seeElementInDOM`. Checks that element is not on page.
|
|
10197
10194
|
*
|
|
@@ -10201,7 +10198,7 @@ declare namespace CodeceptJS {
|
|
|
10201
10198
|
* @param locator - located by CSS|XPath|Strict locator.
|
|
10202
10199
|
* @returns automatically synchronized promise through #recorder
|
|
10203
10200
|
*/
|
|
10204
|
-
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString):
|
|
10201
|
+
dontSeeElementInDOM(locator: CodeceptJS.LocatorOrString): void;
|
|
10205
10202
|
/**
|
|
10206
10203
|
* Checks that the current page contains the given string in its raw source code.
|
|
10207
10204
|
*
|
|
@@ -10211,7 +10208,7 @@ declare namespace CodeceptJS {
|
|
|
10211
10208
|
* @param text - value to check.
|
|
10212
10209
|
* @returns automatically synchronized promise through #recorder
|
|
10213
10210
|
*/
|
|
10214
|
-
seeInSource(text: string):
|
|
10211
|
+
seeInSource(text: string): void;
|
|
10215
10212
|
/**
|
|
10216
10213
|
* Retrieves page source and returns it to test.
|
|
10217
10214
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -10253,7 +10250,7 @@ declare namespace CodeceptJS {
|
|
|
10253
10250
|
* @param value - to check.
|
|
10254
10251
|
* @returns automatically synchronized promise through #recorder
|
|
10255
10252
|
*/
|
|
10256
|
-
dontSeeInSource(value: string):
|
|
10253
|
+
dontSeeInSource(value: string): void;
|
|
10257
10254
|
/**
|
|
10258
10255
|
* Asserts that an element appears a given number of times in the DOM.
|
|
10259
10256
|
* Element is located by label or name or CSS or XPath.
|
|
@@ -10268,7 +10265,7 @@ declare namespace CodeceptJS {
|
|
|
10268
10265
|
*
|
|
10269
10266
|
* {{ react }}
|
|
10270
10267
|
*/
|
|
10271
|
-
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
10268
|
+
seeNumberOfElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
10272
10269
|
/**
|
|
10273
10270
|
* Asserts that an element is visible a given number of times.
|
|
10274
10271
|
* Element is located by CSS or XPath.
|
|
@@ -10282,7 +10279,7 @@ declare namespace CodeceptJS {
|
|
|
10282
10279
|
*
|
|
10283
10280
|
* {{ react }}
|
|
10284
10281
|
*/
|
|
10285
|
-
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number):
|
|
10282
|
+
seeNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number): void;
|
|
10286
10283
|
/**
|
|
10287
10284
|
* Checks that all elements with given locator have given CSS properties.
|
|
10288
10285
|
*
|
|
@@ -10293,7 +10290,7 @@ declare namespace CodeceptJS {
|
|
|
10293
10290
|
* @param cssProperties - object with CSS properties and their values to check.
|
|
10294
10291
|
* @returns automatically synchronized promise through #recorder
|
|
10295
10292
|
*/
|
|
10296
|
-
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any):
|
|
10293
|
+
seeCssPropertiesOnElements(locator: CodeceptJS.LocatorOrString, cssProperties: any): void;
|
|
10297
10294
|
/**
|
|
10298
10295
|
* Checks that all elements with given locator have given attributes.
|
|
10299
10296
|
*
|
|
@@ -10304,7 +10301,7 @@ declare namespace CodeceptJS {
|
|
|
10304
10301
|
* @param attributes - attributes and their values to check.
|
|
10305
10302
|
* @returns automatically synchronized promise through #recorder
|
|
10306
10303
|
*/
|
|
10307
|
-
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any):
|
|
10304
|
+
seeAttributesOnElements(locator: CodeceptJS.LocatorOrString, attributes: any): void;
|
|
10308
10305
|
/**
|
|
10309
10306
|
* Grab number of visible elements by locator.
|
|
10310
10307
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -10325,13 +10322,13 @@ declare namespace CodeceptJS {
|
|
|
10325
10322
|
* @param url - a fragment to check
|
|
10326
10323
|
* @returns automatically synchronized promise through #recorder
|
|
10327
10324
|
*/
|
|
10328
|
-
seeInCurrentUrl(url: string):
|
|
10325
|
+
seeInCurrentUrl(url: string): void;
|
|
10329
10326
|
/**
|
|
10330
10327
|
* Checks that current url does not contain a provided fragment.
|
|
10331
10328
|
* @param url - value to check.
|
|
10332
10329
|
* @returns automatically synchronized promise through #recorder
|
|
10333
10330
|
*/
|
|
10334
|
-
dontSeeInCurrentUrl(url: string):
|
|
10331
|
+
dontSeeInCurrentUrl(url: string): void;
|
|
10335
10332
|
/**
|
|
10336
10333
|
* Checks that current url is equal to provided one.
|
|
10337
10334
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -10344,7 +10341,7 @@ declare namespace CodeceptJS {
|
|
|
10344
10341
|
* @param url - value to check.
|
|
10345
10342
|
* @returns automatically synchronized promise through #recorder
|
|
10346
10343
|
*/
|
|
10347
|
-
seeCurrentUrlEquals(url: string):
|
|
10344
|
+
seeCurrentUrlEquals(url: string): void;
|
|
10348
10345
|
/**
|
|
10349
10346
|
* Checks that current url is not equal to provided one.
|
|
10350
10347
|
* If a relative url provided, a configured url will be prepended to it.
|
|
@@ -10356,7 +10353,7 @@ declare namespace CodeceptJS {
|
|
|
10356
10353
|
* @param url - value to check.
|
|
10357
10354
|
* @returns automatically synchronized promise through #recorder
|
|
10358
10355
|
*/
|
|
10359
|
-
dontSeeCurrentUrlEquals(url: string):
|
|
10356
|
+
dontSeeCurrentUrlEquals(url: string): void;
|
|
10360
10357
|
/**
|
|
10361
10358
|
* Executes sync script on a page.
|
|
10362
10359
|
* Pass arguments to function as additional parameters.
|
|
@@ -10427,7 +10424,7 @@ declare namespace CodeceptJS {
|
|
|
10427
10424
|
* @param scrollIntoViewOptions - see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
|
|
10428
10425
|
* @returns automatically synchronized promise through #recorder
|
|
10429
10426
|
*/
|
|
10430
|
-
scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions):
|
|
10427
|
+
scrollIntoView(locator: LocatorOrString, scrollIntoViewOptions: ScrollIntoViewOptions): void;
|
|
10431
10428
|
/**
|
|
10432
10429
|
* Scrolls to element matched by locator.
|
|
10433
10430
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -10441,7 +10438,7 @@ declare namespace CodeceptJS {
|
|
|
10441
10438
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
10442
10439
|
* @returns automatically synchronized promise through #recorder
|
|
10443
10440
|
*/
|
|
10444
|
-
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
10441
|
+
scrollTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
10445
10442
|
/**
|
|
10446
10443
|
* Moves cursor to element matched by locator.
|
|
10447
10444
|
* Extra shift can be set with offsetX and offsetY options.
|
|
@@ -10455,7 +10452,7 @@ declare namespace CodeceptJS {
|
|
|
10455
10452
|
* @param [offsetY = 0] - (optional, `0` by default) Y-axis offset.
|
|
10456
10453
|
* @returns automatically synchronized promise through #recorder
|
|
10457
10454
|
*/
|
|
10458
|
-
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number):
|
|
10455
|
+
moveCursorTo(locator: CodeceptJS.LocatorOrString, offsetX?: number, offsetY?: number): void;
|
|
10459
10456
|
/**
|
|
10460
10457
|
* Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
10461
10458
|
* Filename is relative to output folder.
|
|
@@ -10467,7 +10464,7 @@ declare namespace CodeceptJS {
|
|
|
10467
10464
|
* @param fileName - file name to save.
|
|
10468
10465
|
* @returns automatically synchronized promise through #recorder
|
|
10469
10466
|
*/
|
|
10470
|
-
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string):
|
|
10467
|
+
saveElementScreenshot(locator: CodeceptJS.LocatorOrString, fileName: string): void;
|
|
10471
10468
|
/**
|
|
10472
10469
|
* Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
|
|
10473
10470
|
* Filename is relative to output folder.
|
|
@@ -10481,7 +10478,7 @@ declare namespace CodeceptJS {
|
|
|
10481
10478
|
* @param [fullPage = false] - (optional, `false` by default) flag to enable fullscreen screenshot mode.
|
|
10482
10479
|
* @returns automatically synchronized promise through #recorder
|
|
10483
10480
|
*/
|
|
10484
|
-
saveScreenshot(fileName: string, fullPage?: boolean):
|
|
10481
|
+
saveScreenshot(fileName: string, fullPage?: boolean): void;
|
|
10485
10482
|
/**
|
|
10486
10483
|
* Sets cookie(s).
|
|
10487
10484
|
*
|
|
@@ -10504,19 +10501,18 @@ declare namespace CodeceptJS {
|
|
|
10504
10501
|
* Uses Selenium's JSON [cookie
|
|
10505
10502
|
* format](https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object).
|
|
10506
10503
|
*/
|
|
10507
|
-
setCookie(cookie: Cookie | Cookie[]):
|
|
10504
|
+
setCookie(cookie: Cookie | Cookie[]): void;
|
|
10508
10505
|
/**
|
|
10509
10506
|
* Clears a cookie by name,
|
|
10510
10507
|
* if none provided clears all cookies.
|
|
10511
10508
|
*
|
|
10512
10509
|
* ```js
|
|
10513
10510
|
* I.clearCookie();
|
|
10514
|
-
* I.clearCookie('test');
|
|
10511
|
+
* I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
|
|
10515
10512
|
* ```
|
|
10516
10513
|
* @param [cookie = null] - (optional, `null` by default) cookie name
|
|
10517
|
-
* @returns automatically synchronized promise through #recorder
|
|
10518
10514
|
*/
|
|
10519
|
-
clearCookie(cookie?: string):
|
|
10515
|
+
clearCookie(cookie?: string): void;
|
|
10520
10516
|
/**
|
|
10521
10517
|
* Checks that cookie with given name exists.
|
|
10522
10518
|
*
|
|
@@ -10526,7 +10522,7 @@ declare namespace CodeceptJS {
|
|
|
10526
10522
|
* @param name - cookie name.
|
|
10527
10523
|
* @returns automatically synchronized promise through #recorder
|
|
10528
10524
|
*/
|
|
10529
|
-
seeCookie(name: string):
|
|
10525
|
+
seeCookie(name: string): void;
|
|
10530
10526
|
/**
|
|
10531
10527
|
* Checks that cookie with given name does not exist.
|
|
10532
10528
|
*
|
|
@@ -10536,7 +10532,7 @@ declare namespace CodeceptJS {
|
|
|
10536
10532
|
* @param name - cookie name.
|
|
10537
10533
|
* @returns automatically synchronized promise through #recorder
|
|
10538
10534
|
*/
|
|
10539
|
-
dontSeeCookie(name: string):
|
|
10535
|
+
dontSeeCookie(name: string): void;
|
|
10540
10536
|
/**
|
|
10541
10537
|
* Gets a cookie object by name.
|
|
10542
10538
|
* If none provided gets all cookies.
|
|
@@ -10586,7 +10582,7 @@ declare namespace CodeceptJS {
|
|
|
10586
10582
|
* @param key - name of key to press down.
|
|
10587
10583
|
* @returns automatically synchronized promise through #recorder
|
|
10588
10584
|
*/
|
|
10589
|
-
pressKeyDown(key: string):
|
|
10585
|
+
pressKeyDown(key: string): void;
|
|
10590
10586
|
/**
|
|
10591
10587
|
* Releases a key in the browser which was previously set to a down state.
|
|
10592
10588
|
*
|
|
@@ -10600,7 +10596,7 @@ declare namespace CodeceptJS {
|
|
|
10600
10596
|
* @param key - name of key to release.
|
|
10601
10597
|
* @returns automatically synchronized promise through #recorder
|
|
10602
10598
|
*/
|
|
10603
|
-
pressKeyUp(key: string):
|
|
10599
|
+
pressKeyUp(key: string): void;
|
|
10604
10600
|
/**
|
|
10605
10601
|
* Presses a key in the browser (on a focused element).
|
|
10606
10602
|
*
|
|
@@ -10665,7 +10661,7 @@ declare namespace CodeceptJS {
|
|
|
10665
10661
|
*
|
|
10666
10662
|
* _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.
|
|
10667
10663
|
*/
|
|
10668
|
-
pressKey(key: string | string[]):
|
|
10664
|
+
pressKey(key: string | string[]): void;
|
|
10669
10665
|
/**
|
|
10670
10666
|
* Types out the given text into an active field.
|
|
10671
10667
|
* To slow down typing use a second parameter, to set interval between key presses.
|
|
@@ -10688,7 +10684,7 @@ declare namespace CodeceptJS {
|
|
|
10688
10684
|
* @param [delay = null] - (optional) delay in ms between key presses
|
|
10689
10685
|
* @returns automatically synchronized promise through #recorder
|
|
10690
10686
|
*/
|
|
10691
|
-
type(key: string | string[], delay?: number):
|
|
10687
|
+
type(key: string | string[], delay?: number): void;
|
|
10692
10688
|
/**
|
|
10693
10689
|
* Resize the current window to provided width and height.
|
|
10694
10690
|
* First parameter can be set to `maximize`.
|
|
@@ -10698,7 +10694,7 @@ declare namespace CodeceptJS {
|
|
|
10698
10694
|
*
|
|
10699
10695
|
* Appium: not tested in web, in apps doesn't work
|
|
10700
10696
|
*/
|
|
10701
|
-
resizeWindow(width: number, height: number):
|
|
10697
|
+
resizeWindow(width: number, height: number): void;
|
|
10702
10698
|
/**
|
|
10703
10699
|
* Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the matching element.
|
|
10704
10700
|
*
|
|
@@ -10713,7 +10709,7 @@ declare namespace CodeceptJS {
|
|
|
10713
10709
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
|
|
10714
10710
|
* @returns automatically synchronized promise through #recorder
|
|
10715
10711
|
*/
|
|
10716
|
-
focus(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
10712
|
+
focus(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
10717
10713
|
/**
|
|
10718
10714
|
* Remove focus from a text input, button, etc.
|
|
10719
10715
|
* Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
|
|
@@ -10733,7 +10729,7 @@ declare namespace CodeceptJS {
|
|
|
10733
10729
|
* @param [options] - Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
|
|
10734
10730
|
* @returns automatically synchronized promise through #recorder
|
|
10735
10731
|
*/
|
|
10736
|
-
blur(locator: CodeceptJS.LocatorOrString, options?: any):
|
|
10732
|
+
blur(locator: CodeceptJS.LocatorOrString, options?: any): void;
|
|
10737
10733
|
/**
|
|
10738
10734
|
* Drag an item to a destination element.
|
|
10739
10735
|
*
|
|
@@ -10746,7 +10742,7 @@ declare namespace CodeceptJS {
|
|
|
10746
10742
|
*
|
|
10747
10743
|
* Appium: not tested
|
|
10748
10744
|
*/
|
|
10749
|
-
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString):
|
|
10745
|
+
dragAndDrop(srcElement: LocatorOrString, destElement: LocatorOrString): void;
|
|
10750
10746
|
/**
|
|
10751
10747
|
* Drag the scrubber of a slider to a given position
|
|
10752
10748
|
* For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
|
|
@@ -10759,7 +10755,7 @@ declare namespace CodeceptJS {
|
|
|
10759
10755
|
* @param offsetX - position to drag.
|
|
10760
10756
|
* @returns automatically synchronized promise through #recorder
|
|
10761
10757
|
*/
|
|
10762
|
-
dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number):
|
|
10758
|
+
dragSlider(locator: CodeceptJS.LocatorOrString, offsetX: number): void;
|
|
10763
10759
|
/**
|
|
10764
10760
|
* Get all Window Handles.
|
|
10765
10761
|
* Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
|
|
@@ -10801,7 +10797,7 @@ declare namespace CodeceptJS {
|
|
|
10801
10797
|
* ```
|
|
10802
10798
|
* @returns automatically synchronized promise through #recorder
|
|
10803
10799
|
*/
|
|
10804
|
-
closeOtherTabs():
|
|
10800
|
+
closeOtherTabs(): void;
|
|
10805
10801
|
/**
|
|
10806
10802
|
* Pauses execution for a number of seconds.
|
|
10807
10803
|
*
|
|
@@ -10811,7 +10807,7 @@ declare namespace CodeceptJS {
|
|
|
10811
10807
|
* @param sec - number of second to wait.
|
|
10812
10808
|
* @returns automatically synchronized promise through #recorder
|
|
10813
10809
|
*/
|
|
10814
|
-
wait(sec: number):
|
|
10810
|
+
wait(sec: number): void;
|
|
10815
10811
|
/**
|
|
10816
10812
|
* Waits for element to become enabled (by default waits for 1sec).
|
|
10817
10813
|
* Element can be located by CSS or XPath.
|
|
@@ -10819,7 +10815,7 @@ declare namespace CodeceptJS {
|
|
|
10819
10815
|
* @param [sec = 1] - (optional) time in seconds to wait, 1 by default.
|
|
10820
10816
|
* @returns automatically synchronized promise through #recorder
|
|
10821
10817
|
*/
|
|
10822
|
-
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10818
|
+
waitForEnabled(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10823
10819
|
/**
|
|
10824
10820
|
* Waits for element to be present on page (by default waits for 1sec).
|
|
10825
10821
|
* Element can be located by CSS or XPath.
|
|
@@ -10832,7 +10828,7 @@ declare namespace CodeceptJS {
|
|
|
10832
10828
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
10833
10829
|
* @returns automatically synchronized promise through #recorder
|
|
10834
10830
|
*/
|
|
10835
|
-
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10831
|
+
waitForElement(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10836
10832
|
/**
|
|
10837
10833
|
* Waits for element to be clickable (by default waits for 1sec).
|
|
10838
10834
|
* Element can be located by CSS or XPath.
|
|
@@ -10845,7 +10841,7 @@ declare namespace CodeceptJS {
|
|
|
10845
10841
|
* @param [sec] - (optional, `1` by default) time in seconds to wait
|
|
10846
10842
|
* @returns automatically synchronized promise through #recorder
|
|
10847
10843
|
*/
|
|
10848
|
-
waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10844
|
+
waitForClickable(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10849
10845
|
/**
|
|
10850
10846
|
* Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
|
|
10851
10847
|
*
|
|
@@ -10856,7 +10852,7 @@ declare namespace CodeceptJS {
|
|
|
10856
10852
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10857
10853
|
* @returns automatically synchronized promise through #recorder
|
|
10858
10854
|
*/
|
|
10859
|
-
waitInUrl(urlPart: string, sec?: number):
|
|
10855
|
+
waitInUrl(urlPart: string, sec?: number): void;
|
|
10860
10856
|
/**
|
|
10861
10857
|
* Waits for the entire URL to match the expected
|
|
10862
10858
|
*
|
|
@@ -10868,7 +10864,7 @@ declare namespace CodeceptJS {
|
|
|
10868
10864
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10869
10865
|
* @returns automatically synchronized promise through #recorder
|
|
10870
10866
|
*/
|
|
10871
|
-
waitUrlEquals(urlPart: string, sec?: number):
|
|
10867
|
+
waitUrlEquals(urlPart: string, sec?: number): void;
|
|
10872
10868
|
/**
|
|
10873
10869
|
* Waits for a text to appear (by default waits for 1sec).
|
|
10874
10870
|
* Element can be located by CSS or XPath.
|
|
@@ -10883,7 +10879,7 @@ declare namespace CodeceptJS {
|
|
|
10883
10879
|
* @param [context = null] - (optional) element located by CSS|XPath|strict locator.
|
|
10884
10880
|
* @returns automatically synchronized promise through #recorder
|
|
10885
10881
|
*/
|
|
10886
|
-
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString):
|
|
10882
|
+
waitForText(text: string, sec?: number, context?: CodeceptJS.LocatorOrString): void;
|
|
10887
10883
|
/**
|
|
10888
10884
|
* Waits for the specified value to be in value attribute.
|
|
10889
10885
|
*
|
|
@@ -10895,7 +10891,7 @@ declare namespace CodeceptJS {
|
|
|
10895
10891
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10896
10892
|
* @returns automatically synchronized promise through #recorder
|
|
10897
10893
|
*/
|
|
10898
|
-
waitForValue(field: LocatorOrString, value: string, sec?: number):
|
|
10894
|
+
waitForValue(field: LocatorOrString, value: string, sec?: number): void;
|
|
10899
10895
|
/**
|
|
10900
10896
|
* Waits for an element to become visible on a page (by default waits for 1sec).
|
|
10901
10897
|
* Element can be located by CSS or XPath.
|
|
@@ -10907,7 +10903,7 @@ declare namespace CodeceptJS {
|
|
|
10907
10903
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10908
10904
|
* @returns automatically synchronized promise through #recorder
|
|
10909
10905
|
*/
|
|
10910
|
-
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10906
|
+
waitForVisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10911
10907
|
/**
|
|
10912
10908
|
* Waits for a specified number of elements on the page.
|
|
10913
10909
|
*
|
|
@@ -10919,7 +10915,7 @@ declare namespace CodeceptJS {
|
|
|
10919
10915
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10920
10916
|
* @returns automatically synchronized promise through #recorder
|
|
10921
10917
|
*/
|
|
10922
|
-
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number):
|
|
10918
|
+
waitNumberOfVisibleElements(locator: CodeceptJS.LocatorOrString, num: number, sec?: number): void;
|
|
10923
10919
|
/**
|
|
10924
10920
|
* Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
|
|
10925
10921
|
* Element can be located by CSS or XPath.
|
|
@@ -10931,7 +10927,7 @@ declare namespace CodeceptJS {
|
|
|
10931
10927
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10932
10928
|
* @returns automatically synchronized promise through #recorder
|
|
10933
10929
|
*/
|
|
10934
|
-
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10930
|
+
waitForInvisible(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10935
10931
|
/**
|
|
10936
10932
|
* Waits for an element to hide (by default waits for 1sec).
|
|
10937
10933
|
* Element can be located by CSS or XPath.
|
|
@@ -10943,7 +10939,7 @@ declare namespace CodeceptJS {
|
|
|
10943
10939
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10944
10940
|
* @returns automatically synchronized promise through #recorder
|
|
10945
10941
|
*/
|
|
10946
|
-
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10942
|
+
waitToHide(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10947
10943
|
/**
|
|
10948
10944
|
* Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
|
|
10949
10945
|
* Element can be located by CSS or XPath.
|
|
@@ -10955,7 +10951,7 @@ declare namespace CodeceptJS {
|
|
|
10955
10951
|
* @param [sec = 1] - (optional, `1` by default) time in seconds to wait
|
|
10956
10952
|
* @returns automatically synchronized promise through #recorder
|
|
10957
10953
|
*/
|
|
10958
|
-
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number):
|
|
10954
|
+
waitForDetached(locator: CodeceptJS.LocatorOrString, sec?: number): void;
|
|
10959
10955
|
/**
|
|
10960
10956
|
* Waits for a function to return true (waits for 1 sec by default).
|
|
10961
10957
|
* Running in browser context.
|
|
@@ -10974,7 +10970,7 @@ declare namespace CodeceptJS {
|
|
|
10974
10970
|
* @param [sec = null] - (optional, `1` by default) time in seconds to wait
|
|
10975
10971
|
* @returns automatically synchronized promise through #recorder
|
|
10976
10972
|
*/
|
|
10977
|
-
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number):
|
|
10973
|
+
waitForFunction(fn: string | ((...params: any[]) => any), argsOrSec?: any[] | number, sec?: number): void;
|
|
10978
10974
|
/**
|
|
10979
10975
|
* Switches frame or in case of null locator reverts to parent.
|
|
10980
10976
|
*
|
|
@@ -10985,7 +10981,7 @@ declare namespace CodeceptJS {
|
|
|
10985
10981
|
* @param [locator = null] - (optional, `null` by default) element located by CSS|XPath|strict locator.
|
|
10986
10982
|
* @returns automatically synchronized promise through #recorder
|
|
10987
10983
|
*/
|
|
10988
|
-
switchTo(locator?: CodeceptJS.LocatorOrString):
|
|
10984
|
+
switchTo(locator?: CodeceptJS.LocatorOrString): void;
|
|
10989
10985
|
/**
|
|
10990
10986
|
* Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
|
|
10991
10987
|
*
|
|
@@ -10997,7 +10993,7 @@ declare namespace CodeceptJS {
|
|
|
10997
10993
|
* @param [sec = null] - (optional) time in seconds to wait.
|
|
10998
10994
|
* @returns automatically synchronized promise through #recorder
|
|
10999
10995
|
*/
|
|
11000
|
-
switchToNextTab(num?: number, sec?: number | null):
|
|
10996
|
+
switchToNextTab(num?: number, sec?: number | null): void;
|
|
11001
10997
|
/**
|
|
11002
10998
|
* Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
|
|
11003
10999
|
*
|
|
@@ -11009,7 +11005,7 @@ declare namespace CodeceptJS {
|
|
|
11009
11005
|
* @param [sec = null] - (optional) time in seconds to wait.
|
|
11010
11006
|
* @returns automatically synchronized promise through #recorder
|
|
11011
11007
|
*/
|
|
11012
|
-
switchToPreviousTab(num?: number, sec?: number):
|
|
11008
|
+
switchToPreviousTab(num?: number, sec?: number): void;
|
|
11013
11009
|
/**
|
|
11014
11010
|
* Close current tab.
|
|
11015
11011
|
*
|
|
@@ -11018,7 +11014,7 @@ declare namespace CodeceptJS {
|
|
|
11018
11014
|
* ```
|
|
11019
11015
|
* @returns automatically synchronized promise through #recorder
|
|
11020
11016
|
*/
|
|
11021
|
-
closeCurrentTab():
|
|
11017
|
+
closeCurrentTab(): void;
|
|
11022
11018
|
/**
|
|
11023
11019
|
* Open new tab and switch to it.
|
|
11024
11020
|
*
|
|
@@ -11027,7 +11023,7 @@ declare namespace CodeceptJS {
|
|
|
11027
11023
|
* ```
|
|
11028
11024
|
* @returns automatically synchronized promise through #recorder
|
|
11029
11025
|
*/
|
|
11030
|
-
openNewTab():
|
|
11026
|
+
openNewTab(): void;
|
|
11031
11027
|
/**
|
|
11032
11028
|
* Grab number of open tabs.
|
|
11033
11029
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|
|
@@ -11046,7 +11042,7 @@ declare namespace CodeceptJS {
|
|
|
11046
11042
|
* ```
|
|
11047
11043
|
* @returns automatically synchronized promise through #recorder
|
|
11048
11044
|
*/
|
|
11049
|
-
refreshPage():
|
|
11045
|
+
refreshPage(): void;
|
|
11050
11046
|
/**
|
|
11051
11047
|
* Scroll page to the top.
|
|
11052
11048
|
*
|
|
@@ -11055,7 +11051,7 @@ declare namespace CodeceptJS {
|
|
|
11055
11051
|
* ```
|
|
11056
11052
|
* @returns automatically synchronized promise through #recorder
|
|
11057
11053
|
*/
|
|
11058
|
-
scrollPageToTop():
|
|
11054
|
+
scrollPageToTop(): void;
|
|
11059
11055
|
/**
|
|
11060
11056
|
* Scroll page to the bottom.
|
|
11061
11057
|
*
|
|
@@ -11064,7 +11060,7 @@ declare namespace CodeceptJS {
|
|
|
11064
11060
|
* ```
|
|
11065
11061
|
* @returns automatically synchronized promise through #recorder
|
|
11066
11062
|
*/
|
|
11067
|
-
scrollPageToBottom():
|
|
11063
|
+
scrollPageToBottom(): void;
|
|
11068
11064
|
/**
|
|
11069
11065
|
* Retrieves a page scroll position and returns it to test.
|
|
11070
11066
|
* Resumes test execution, so **should be used inside an async function with `await`** operator.
|
|
@@ -11088,7 +11084,7 @@ declare namespace CodeceptJS {
|
|
|
11088
11084
|
* @param [altitude = null] - (optional, null by default) to set
|
|
11089
11085
|
* @returns automatically synchronized promise through #recorder
|
|
11090
11086
|
*/
|
|
11091
|
-
setGeoLocation(latitude: number, longitude: number, altitude?: number):
|
|
11087
|
+
setGeoLocation(latitude: number, longitude: number, altitude?: number): void;
|
|
11092
11088
|
/**
|
|
11093
11089
|
* Return the current geo location
|
|
11094
11090
|
* Resumes test execution, so **should be used inside async function with `await`** operator.
|