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