codeceptjs 4.0.0-rc.17 → 4.0.0-rc.19

package/docs/webapi/grabAttributeFromAll.mustache

@@ -1,9 +0,0 @@
-Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let hints = await I.grabAttributeFromAll('.tooltip', 'title');
-```
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {string} attr attribute name.
-@returns {Promise<string[]>} attribute value

package/docs/webapi/grabBrowserLogs.mustache

@@ -1,9 +0,0 @@
-Get JS log from browser. Log buffer is reset after each request.
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-let logs = await I.grabBrowserLogs();
-console.log(JSON.stringify(logs))
-```
-
-@returns {Promise<object[]>|undefined} all browser logs

package/docs/webapi/grabCookie.mustache

@@ -1,11 +0,0 @@
-Gets a cookie object by name.
-If none provided gets all cookies.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let cookie = await I.grabCookie('auth');
-assert(cookie.value, '123456');
-```
-
-@param {?string} [name=null] cookie name.
-@returns {any} attribute value

package/docs/webapi/grabCssPropertyFrom.mustache

@@ -1,11 +0,0 @@
-Grab CSS property for given locator
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-If more than one element is found - value of first element is returned.
-
-```js
-const value = await I.grabCssPropertyFrom('h3', 'font-weight');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {string} cssProperty CSS property name.
-@returns {Promise<string>} CSS value

package/docs/webapi/grabCssPropertyFromAll.mustache

@@ -1,10 +0,0 @@
-Grab array of CSS properties for given locator
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {string} cssProperty CSS property name.
-@returns {Promise<string[]>} CSS value

package/docs/webapi/grabCurrentUrl.mustache

@@ -1,9 +0,0 @@
-Get current URL from browser.
-Resumes test execution, so should be used inside an async function.
-
-```js
-let url = await I.grabCurrentUrl();
-console.log(`Current URL is [${url}]`);
-```
-
-@returns {Promise<string>} current URL

package/docs/webapi/grabCurrentWindowHandle.mustache

@@ -1,6 +0,0 @@
-Get the current Window Handle.
-Useful for referencing it when calling `I.switchToWindow(handle)`
-```js
-const window = await I.grabCurrentWindowHandle();
-```
-@returns {Promise<string>}

package/docs/webapi/grabDataFromPerformanceTiming.mustache

@@ -1,20 +0,0 @@
-Grab the data from performance timing using Navigation Timing API.
-The returned data will contain following things in ms:
-- responseEnd,
-- domInteractive,
-- domContentLoadedEventEnd,
-- loadEventEnd
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-await I.amOnPage('https://example.com');
-let data = await I.grabDataFromPerformanceTiming();
-//Returned data
-{ // all results are in [ms]
-  responseEnd: 23,
-  domInteractive: 44,
-  domContentLoadedEventEnd: 196,
-  loadEventEnd: 241
-}
-```
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/grabElementBoundingRect.mustache

@@ -1,20 +0,0 @@
-Grab the width, height, location of given locator.
-Provide `width` or `height`as second param to get your desired prop.
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-Returns an object with `x`, `y`, `width`, `height` keys.
-
-```js
-const value = await I.grabElementBoundingRect('h3');
-// value is like { x: 226.5, y: 89, width: 527, height: 220 }
-```
-
-To get only one metric use second parameter:
-
-```js
-const width = await I.grabElementBoundingRect('h3', 'width');
-// width == 527
-```
-@param {LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {string=} elementSize x, y, width or height of the given element.
-@returns {Promise<DOMRect>|Promise<number>} Element bounding rectangle

package/docs/webapi/grabGeoLocation.mustache

@@ -1,8 +0,0 @@
-Return the current geo location 
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let geoLocation = await I.grabGeoLocation();
-```
-
-@returns {Promise<{ latitude: number, longitude: number, altitude: number }>}

package/docs/webapi/grabHTMLFrom.mustache

@@ -1,10 +0,0 @@
-Retrieves the innerHTML from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-If more than one element is found - HTML of first element is returned.
-
-```js
-let postHTML = await I.grabHTMLFrom('#post');
-```
-
-@param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
-@returns {Promise<string>} HTML code for an element

package/docs/webapi/grabHTMLFromAll.mustache

@@ -1,9 +0,0 @@
-Retrieves all the innerHTML from elements located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let postHTMLs = await I.grabHTMLFromAll('.post');
-```
-
-@param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
-@returns {Promise<string[]>} HTML code for an element

package/docs/webapi/grabNumberOfOpenTabs.mustache

@@ -1,8 +0,0 @@
-Grab number of open tabs.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let tabs = await I.grabNumberOfOpenTabs();
-```
-
-@returns {Promise<number>} number of open tabs

package/docs/webapi/grabNumberOfVisibleElements.mustache

@@ -1,9 +0,0 @@
-Grab number of visible elements by locator.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let numOfElements = await I.grabNumberOfVisibleElements('p');
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@returns {Promise<number>} number of visible elements

package/docs/webapi/grabPageScrollPosition.mustache

@@ -1,8 +0,0 @@
-Retrieves a page scroll position and returns it to test.
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-let { x, y } = await I.grabPageScrollPosition();
-```
-
-@returns {Promise<PageScrollPosition>} scroll position

package/docs/webapi/grabPopupText.mustache

@@ -1,5 +0,0 @@
-Grab the text within the popup. If no popup is visible then it will return null.
-```js
-await I.grabPopupText();
-```
-@returns {Promise<string>}

package/docs/webapi/grabRecordedNetworkTraffics.mustache

@@ -1,10 +0,0 @@
-Grab the recording network traffics
-
-```js
-const traffics = await I.grabRecordedNetworkTraffics();
-expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
-expect(traffics[0].response.status).to.equal(200);
-expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
-```
-
-@return { Array } recorded network traffics

package/docs/webapi/grabSource.mustache

@@ -1,8 +0,0 @@
-Retrieves page source and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let pageSource = await I.grabSource();
-```
-
-@returns {Promise<string>} source code

package/docs/webapi/grabTextFrom.mustache

@@ -1,10 +0,0 @@
-Retrieves a text from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let pin = await I.grabTextFrom('#pin');
-```
-If multiple elements found returns first element.
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@returns {Promise<string>} attribute value

package/docs/webapi/grabTextFromAll.mustache

@@ -1,9 +0,0 @@
-Retrieves all texts from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let pins = await I.grabTextFromAll('#pin li');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@returns {Promise<string[]>} attribute value

package/docs/webapi/grabTitle.mustache

@@ -1,8 +0,0 @@
-Retrieves a page title and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let title = await I.grabTitle();
-```
-
-@returns {Promise<string>} title

package/docs/webapi/grabValueFrom.mustache

@@ -1,9 +0,0 @@
-Retrieves a value from a form element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-If more than one element is found - value of first element is returned.
-
-```js
-let email = await I.grabValueFrom('input[name=email]');
-```
-@param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
-@returns {Promise<string>} attribute value

package/docs/webapi/grabValueFromAll.mustache

@@ -1,8 +0,0 @@
-Retrieves an array of value from a form located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let inputs = await I.grabValueFromAll('//form/input');
-```
-@param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
-@returns {Promise<string[]>} attribute value

package/docs/webapi/grabWebElement.mustache

@@ -1,9 +0,0 @@
-Grab WebElement for given locator
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-const webElement = await I.grabWebElement('#button');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@returns {Promise<*>} WebElement of being used Web helper

package/docs/webapi/grabWebElements.mustache

@@ -1,9 +0,0 @@
-Grab WebElements for given locator
-Resumes test execution, so **should be used inside an async function with `await`** operator.
-
-```js
-const webElements = await I.grabWebElements('#button');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@returns {Promise<*>} WebElement of being used Web helper

package/docs/webapi/moveCursorTo.mustache

@@ -1,16 +0,0 @@
-Moves cursor to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
-
-An optional `context` (as a second parameter) can be specified to narrow the search to an element within a parent.
-When the second argument is a non-number (string or locator object), it is treated as context.
-
-```js
-I.moveCursorTo('.tooltip');
-I.moveCursorTo('#submit', 5,5);
-I.moveCursorTo('#submit', '.container');
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {number|CodeceptJS.LocatorOrString} [offsetX=0] (optional, `0` by default) X-axis offset or context locator.
-@param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/openNewTab.mustache

@@ -1,7 +0,0 @@
-Open new tab and switch to it.
-
-```js
-I.openNewTab();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/pressKey.mustache

@@ -1,12 +0,0 @@
-Presses a key on a focused element.
-Special keys like 'Enter', 'Control', [etc](https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value)
-will be replaced with corresponding unicode.
-If modifier key is used (Control, Command, Alt, Shift) in array, it will be released afterwards.
-
-```js
-I.pressKey('Enter');
-I.pressKey(['Control','a']);
-```
-
-@param {string|string[]} key key or array of keys to press.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/pressKeyDown.mustache

@@ -1,12 +0,0 @@
-Presses a key in the browser and leaves it in a down state.
-
-To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`](#click)).
-
-```js
-I.pressKeyDown('Control');
-I.click('#element');
-I.pressKeyUp('Control');
-```
-
-@param {string} key name of key to press down.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/pressKeyUp.mustache

@@ -1,12 +0,0 @@
-Releases a key in the browser which was previously set to a down state.
-
-To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`](#click)).
-
-```js
-I.pressKeyDown('Control');
-I.click('#element');
-I.pressKeyUp('Control');
-```
-
-@param {string} key name of key to release.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/pressKeyWithKeyNormalization.mustache

@@ -1,60 +0,0 @@
-Presses a key in the browser (on a focused element).
-
-_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`](#fillfield).
-
-```js
-I.pressKey('Backspace');
-```
-
-To press a key in combination with modifier keys, pass the sequence as an array. All modifier keys (`'Alt'`, `'Control'`, `'Meta'`, `'Shift'`) will be released afterwards.
-
-```js
-I.pressKey(['Control', 'Z']);
-```
-
-For specifying operation modifier key based on operating system it is suggested to use `'CommandOrControl'`.
-This will press `'Command'` (also known as `'Meta'`) on macOS machines and `'Control'` on non-macOS machines.
-
-```js
-I.pressKey(['CommandOrControl', 'Z']);
-```
-
-Some of the supported key names are:
-- `'AltLeft'` or `'Alt'`
-- `'AltRight'`
-- `'ArrowDown'`
-- `'ArrowLeft'`
-- `'ArrowRight'`
-- `'ArrowUp'`
-- `'Backspace'`
-- `'Clear'`
-- `'ControlLeft'` or `'Control'`
-- `'ControlRight'`
-- `'Command'`
-- `'CommandOrControl'`
-- `'Delete'`
-- `'End'`
-- `'Enter'`
-- `'Escape'`
-- `'F1'` to `'F12'`
-- `'Home'`
-- `'Insert'`
-- `'MetaLeft'` or `'Meta'`
-- `'MetaRight'`
-- `'Numpad0'` to `'Numpad9'`
-- `'NumpadAdd'`
-- `'NumpadDecimal'`
-- `'NumpadDivide'`
-- `'NumpadMultiply'`
-- `'NumpadSubtract'`
-- `'PageDown'`
-- `'PageUp'`
-- `'Pause'`
-- `'Return'`
-- `'ShiftLeft'` or `'Shift'`
-- `'ShiftRight'`
-- `'Space'`
-- `'Tab'`
-
-@param {string|string[]} key key or array of keys to press.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/refreshPage.mustache

@@ -1,6 +0,0 @@
-Reload the current page.
-
-```js
-I.refreshPage();
-```
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/resizeWindow.mustache

@@ -1,6 +0,0 @@
-Resize the current window to provided width and height.
-First parameter can be set to `maximize`.
-
-@param {number} width width in pixels or `maximize`.
-@param {number} height height in pixels.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/rightClick.mustache

@@ -1,14 +0,0 @@
-Performs right click on a clickable element matched by semantic locator, CSS or XPath.
-
-```js
-// right click element with id el
-I.rightClick('#el');
-// right click link or button with text "Click me"
-I.rightClick('Click me');
-// right click button with text "Click me" inside .context
-I.rightClick('Click me', '.context');
-```
-
-@param {CodeceptJS.LocatorOrString} locator clickable element located by CSS|XPath|strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/saveElementScreenshot.mustache

@@ -1,10 +0,0 @@
-Saves screenshot of the specified locator to ouput folder (set in codecept.conf.ts or codecept.conf.js).
-Filename is relative to output folder.
-
-```js
-I.saveElementScreenshot(`#submit`,'debug.png');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {string} fileName file name to save.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/saveScreenshot.mustache

@@ -1,12 +0,0 @@
-Saves a screenshot to ouput folder (set in codecept.conf.ts or codecept.conf.js).
-Filename is relative to output folder.
-Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
-
-```js
-I.saveScreenshot('debug.png');
-I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
-```
-
-@param {string} fileName file name to save.
-@param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/say.mustache

@@ -1,10 +0,0 @@
-Print a text in console log
-
-```js
-I.say('This is red', 'red'); //red is used
-I.say('This is blue', 'blue'); //blue is used
-I.say('This is by default'); //cyan is used
-```
-@param {string} text expected on console log.
-@param {string} [color='cyan'] color you want to use.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/scrollIntoView.mustache

@@ -1,11 +0,0 @@
-Scroll element into viewport.
-
-```js
-I.scrollIntoView('#submit');
-I.scrollIntoView('#submit', true);
-I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
-```
-
-@param {LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {ScrollIntoViewOptions|boolean} scrollIntoViewOptions either alignToTop=true|false or scrollIntoViewOptions. See https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/scrollPageToBottom.mustache

@@ -1,6 +0,0 @@
-Scroll page to the bottom.
-
-```js
-I.scrollPageToBottom();
-```
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/scrollPageToTop.mustache

@@ -1,6 +0,0 @@
-Scroll page to the top.
-
-```js
-I.scrollPageToTop();
-```
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/scrollTo.mustache

@@ -1,12 +0,0 @@
-Scrolls to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
-
-```js
-I.scrollTo('footer');
-I.scrollTo('#submit', 5, 5);
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {number} [offsetX=0] (optional, `0` by default) X-axis offset.
-@param {number} [offsetY=0] (optional, `0` by default) Y-axis offset.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/see.mustache

@@ -1,11 +0,0 @@
-Checks that a page contains a visible text.
-Use context parameter to narrow down the search.
-
-```js
-I.see('Welcome'); // text welcome on a page
-I.see('Welcome', '.content'); // text inside .content div
-I.see('Register', {css: 'form.register'}); // use strict locator
-```
-@param {string} text expected on page.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeAttributesOnElements.mustache

@@ -1,9 +0,0 @@
-Checks that all elements with given locator have given attributes.
-
-```js
-I.seeAttributesOnElements('//form', { method: "post"});
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {object} attributes attributes and their values to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeCheckboxIsChecked.mustache

@@ -1,10 +0,0 @@
-Verifies that the specified checkbox is checked.
-
-```js
-I.seeCheckboxIsChecked('Agree');
-I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
-I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
-```
-
-@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeCookie.mustache

@@ -1,8 +0,0 @@
-Checks that cookie with given name exists.
-
-```js
-I.seeCookie('Auth');
-```
-
-@param {string} name cookie name.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeCssPropertiesOnElements.mustache

@@ -1,9 +0,0 @@
-Checks that all elements with given locator have given CSS properties.
-
-```js
-I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {object} cssProperties object with CSS properties and their values to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeCurrentPathEquals.mustache

@@ -1,10 +0,0 @@
-Checks that current URL path matches the expected path.
-Query strings and URL fragments are ignored.
-
-```js
-I.seeCurrentPathEquals('/info'); // passes for '/info', '/info?user=1', '/info#section'
-I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
-```
-
-@param {string} path value to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeCurrentUrlEquals.mustache

@@ -1,11 +0,0 @@
-Checks that current url is equal to provided one.
-If a relative url provided, a configured url will be prepended to it.
-So both examples will work:
-
-```js
-I.seeCurrentUrlEquals('/register');
-I.seeCurrentUrlEquals('http://my.site.com/register');
-```
-
-@param {string} url value to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeElement.mustache

@@ -1,12 +0,0 @@
-Checks that a given Element is visible
-Element is located by CSS or XPath.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-I.seeElement('#modal');
-I.seeElement('#modal', '#container');
-```
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeElementInDOM.mustache

@@ -1,8 +0,0 @@
-Checks that a given Element is present in the DOM
-Element is located by CSS or XPath.
-
-```js
-I.seeElementInDOM('#modal');
-```
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeInCurrentUrl.mustache

@@ -1,8 +0,0 @@
-Checks that current url contains a provided fragment.
-
-```js
-I.seeInCurrentUrl('/register'); // we are on registration page
-```
-
-@param {string} url a fragment to check
-@returns {void} automatically synchronized promise through #recorder