codeceptjs 3.5.12-beta.5 → 3.5.12-beta.7

package/docs/helpers/TestCafe.md

@@ -1,1321 +0,0 @@
----
-permalink: /helpers/TestCafe
-editLink: false
-sidebar: auto
-title: TestCafe
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## TestCafe
-
-**Extends Helper**
-
-Uses [TestCafe][1] library to run cross-browser tests.
-The browser version you want to use in tests must be installed on your system.
-
-Requires `testcafe` package to be installed.
-
-    npm i testcafe --save-dev
-
-## Configuration
-
-This helper should be configured in codecept.conf.ts or codecept.conf.js
-
--   `url`: base url of website to be tested
--   `show`:  - show browser window.
--   `windowSize`: (optional) - set browser window width and height
--   `getPageTimeout`  config option to set maximum navigation time in milliseconds.
--   `waitForTimeout`: (optional) default wait* timeout in ms. Default: 5000.
--   `browser`:   - See [https://devexpress.github.io/testcafe/documentation/using-testcafe/common-concepts/browsers/browser-support.html][2]
-
-#### Example #1: Show chrome browser window
-
-```js
-{
-   helpers: {
-     TestCafe : {
-       url: "http://localhost",
-       waitForTimeout: 15000,
-       show: true,
-       browser: "chrome"
-     }
-   }
-}
-```
-
- To use remote device you can provide 'remote' as browser parameter this will display a link with QR Code
- See [https://devexpress.github.io/testcafe/documentation/recipes/test-on-remote-computers-and-mobile-devices.html][3]
-
-#### Example #2: Remote browser connection
-
-```js
-{
-   helpers: {
-     TestCafe : {
-       url: "http://localhost",
-       waitForTimeout: 15000,
-       browser: "remote"
-     }
-   }
-}
-```
-
-## Access From Helpers
-
-Call Testcafe methods directly using the testcafe controller.
-
-```js
-const testcafeTestController = this.helpers['TestCafe'].t;
-const comboBox = Selector('.combo-box');
-await testcafeTestController
-  .hover(comboBox) // hover over combo box
-  .click('#i-prefer-both') // click some other element
-```
-
-## Methods
-
-### Parameters
-
--   `config`  
-
-### _locate
-
-Get elements by different locator types, including strict locator
-Should be used in custom helpers:
-
-```js
-const elements = await this.helpers['TestCafe']._locate('.item');
-```
-
-#### Parameters
-
--   `locator`  
-
-### amOnPage
-
-Opens a web page in a browser. Requires relative or absolute url.
-If url starts with `/`, opens a web page of a site defined in `url` config parameter.
-
-```js
-I.amOnPage('/'); // opens main page of website
-I.amOnPage('https://github.com'); // opens github
-I.amOnPage('/login'); // opens a login page
-```
-
-#### Parameters
-
--   `url` **[string][4]** url path or global url.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### appendField
-
-Appends text to a input field or textarea.
-Field is located by name, label, CSS or XPath
-
-```js
-I.appendField('#myTextField', 'appended');
-// typing secret
-I.appendField('password', secret('123456'));
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator
--   `value` **[string][4]** text value to append.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### attachFile
-
-Attaches a file to element located by label, name, CSS or XPath
-Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
-File will be uploaded to remote system (if tests are running remotely).
-
-```js
-I.attachFile('Avatar', 'data/avatar.jpg');
-I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
-```
-
-#### Parameters
-
--   `field`  
--   `pathToFile` **[string][4]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### blur
-
-Remove focus from a text input, button, etc.
-Calls [blur][6] on the element.
-
-Examples:
-
-```js
-I.blur('.text-area')
-```
-
-```js
-//element `#product-tile` is focused
-I.see('#add-to-cart-btn');
-I.blur('#product-tile')
-I.dontSee('#add-to-cart-btn');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** Playwright only: [Additional options][7] for available options object as 2nd argument.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### checkOption
-
-Selects a checkbox or radio button.
-Element is located by label or name or CSS or XPath.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-I.checkOption('#agree');
-I.checkOption('I Agree to Terms and Conditions');
-I.checkOption('agree', '//form');
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### clearCookie
-
-Clears a cookie by name,
-if none provided clears all cookies.
-
-```js
-I.clearCookie();
-I.clearCookie('test'); // Playwright currently doesn't support clear a particular cookie name
-```
-
-#### Parameters
-
--   `cookieName`  
--   `cookie` **[string][4]?** (optional, `null` by default) cookie name 
-
-### clearField
-
-Clears a `<textarea>` or text `<input>` element's value.
-
-```js
-I.clearField('Email');
-I.clearField('user[email]');
-I.clearField('#email');
-```
-
-#### Parameters
-
--   `field`  
--   `editable` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
-
-Returns **void** automatically synchronized promise through #recorder.
-
-### click
-
-Perform a click on a link or a button, given by a locator.
-If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
-For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
-For images, the "alt" attribute and inner text of any parent links are searched.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-// simple link
-I.click('Logout');
-// button of form
-I.click('Submit');
-// CSS button
-I.click('#form input[type=submit]');
-// XPath
-I.click('//form/*[@type=submit]');
-// link in context
-I.click('Logout', '#nav');
-// using strict locator
-I.click({css: 'nav a.login'});
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][5] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSee
-
-Opposite to `see`. Checks that a text is not present on a page.
-Use context parameter to narrow down the search.
-
-```js
-I.dontSee('Login'); // assume we are already logged in.
-I.dontSee('Login', '.nav'); // no login inside .nav element
-```
-
-#### Parameters
-
--   `text` **[string][4]** which is not present.
--   `context` **([string][4] | [object][5])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeCheckboxIsChecked
-
-Verifies that the specified checkbox is not checked.
-
-```js
-I.dontSeeCheckboxIsChecked('#agree'); // located by ID
-I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
-I.dontSeeCheckboxIsChecked('agree'); // located by name
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeCookie
-
-Checks that cookie with given name does not exist.
-
-```js
-I.dontSeeCookie('auth'); // no auth cookie
-```
-
-#### Parameters
-
--   `name` **[string][4]** cookie name.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeCurrentUrlEquals
-
-Checks that current url is not equal to provided one.
-If a relative url provided, a configured url will be prepended to it.
-
-```js
-I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
-I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
-```
-
-#### Parameters
-
--   `url` **[string][4]** value to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeElement
-
-Opposite to `seeElement`. Checks that element is not visible (or in DOM)
-
-```js
-I.dontSeeElement('.modal'); // modal is not shown
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|Strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeElementInDOM
-
-Opposite to `seeElementInDOM`. Checks that element is not on page.
-
-```js
-I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|Strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeInCurrentUrl
-
-Checks that current url does not contain a provided fragment.
-
-#### Parameters
-
--   `url` **[string][4]** value to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeInField
-
-Checks that value of input field or textarea doesn't equal to given value
-Opposite to `seeInField`.
-
-```js
-I.dontSeeInField('email', 'user@user.com'); // field by name
-I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] | [object][5])** value to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### dontSeeInSource
-
-Checks that the current page does not contains the given string in its raw source code.
-
-```js
-I.dontSeeInSource('<!--'); // no comments in source
-```
-
-#### Parameters
-
--   `text`  
--   `value` **[string][4]** to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### doubleClick
-
-Performs a double-click on an element matched by link|button|label|CSS or XPath.
-Context can be specified as second parameter to narrow search.
-
-```js
-I.doubleClick('Edit');
-I.doubleClick('Edit', '.actions');
-I.doubleClick({css: 'button.accept'});
-I.doubleClick('.btn.edit');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### executeScript
-
-Executes sync script on a page.
-Pass arguments to function as additional parameters.
-Will return execution result to a test.
-In this case you should use async function and await to receive results.
-
-Example with jQuery DatePicker:
-
-```js
-// change date of jQuery DatePicker
-I.executeScript(function() {
-  // now we are inside browser context
-  $('date').datetimepicker('setDate', new Date());
-});
-```
-
-Can return values. Don't forget to use `await` to get them.
-
-```js
-let date = await I.executeScript(function(el) {
-  // only basic types can be returned
-  return $(el).datetimepicker('getDate').toString();
-}, '#date'); // passing jquery selector
-```
-
-#### Parameters
-
--   `fn` **([string][4] | [function][8])** function to be executed in browser context.
--   `args` **...any** to be passed to function.
-
-Returns **[Promise][9]&lt;any>** script return valueIf a function returns a Promise It will wait for its resolution.
-
-### fillField
-
-Fills a text field or textarea, after clearing its value, with the given string.
-Field is located by name, label, CSS, or XPath.
-
-```js
-// by label
-I.fillField('Email', 'hello@world.com');
-// by name
-I.fillField('password', secret('123456'));
-// by CSS
-I.fillField('form#login input[name=username]', 'John');
-// or by strict locator
-I.fillField({css: 'form#login input[name=username]'}, 'John');
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] | [object][5])** text value to fill.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### focus
-
-Calls [focus][6] on the matching element.
-
-Examples:
-
-```js
-I.dontSee('#add-to-cart-btn');
-I.focus('#product-tile')
-I.see('#add-to-cart-bnt');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `options` **any?** Playwright only: [Additional options][10] for available options object as 2nd argument.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### grabAttributeFrom
-
-Retrieves an attribute 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.
-If more than one element is found - attribute of first element is returned.
-
-```js
-let hint = await I.grabAttributeFrom('#tooltip', 'title');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `attr` **[string][4]** attribute name.
-
-Returns **[Promise][9]&lt;[string][4]>** attribute value
-
-### grabAttributeFromAll
-
-Retrieves an attribute 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.
-If more than one element is found - attribute of first element is returned.
-
-```js
-let hint = await I.grabAttributeFrom('#tooltip', 'title');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `attr` **[string][4]** attribute name.
-
-Returns **[Promise][9]&lt;[string][4]>** attribute value
-
-### grabBrowserLogs
-
-Get JS log from browser.
-
-```js
-let logs = await I.grabBrowserLogs();
-console.log(JSON.stringify(logs))
-```
-
-### grabCookie
-
-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');
-```
-
-#### Parameters
-
--   `name` **[string][4]?** cookie name. 
-
-Returns **any** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
-
-### grabCurrentUrl
-
-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][9]&lt;[string][4]>** current URL
-
-### grabNumberOfVisibleElements
-
-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');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;[number][11]>** number of visible elements
-
-### grabPageScrollPosition
-
-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][9]&lt;PageScrollPosition>** scroll position
-
-### grabSource
-
-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][9]&lt;[string][4]>** source code
-
-### grabTextFrom
-
-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.
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;[string][4]>** attribute value
-
-### grabTextFromAll
-
-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');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;[Array][12]&lt;[string][4]>>** attribute value
-
-### grabValueFrom
-
-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]');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;[string][4]>** attribute value
-
-### grabValueFromAll
-
-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');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
-
-Returns **[Promise][9]&lt;[Array][12]&lt;[string][4]>>** attribute value
-
-### moveCursorTo
-
-Moves cursor to element matched by locator.
-Extra shift can be set with offsetX and offsetY options.
-
-```js
-I.moveCursorTo('.tooltip');
-I.moveCursorTo('#submit', 5,5);
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### pressKey
-
-Presses a key on a focused element.
-Special keys like 'Enter', 'Control', [etc][13]
-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']);
-```
-
-#### Parameters
-
--   `key` **([string][4] | [Array][12]&lt;[string][4]>)** key or array of keys to press.
-
-Returns **void** automatically synchronized promise through #recorder
-
-
-[Valid key names](https://w3c.github.io/webdriver/#keyboard-actions) are:
-
-- `'Add'`,
-- `'Alt'`,
-- `'ArrowDown'` or `'Down arrow'`,
-- `'ArrowLeft'` or `'Left arrow'`,
-- `'ArrowRight'` or `'Right arrow'`,
-- `'ArrowUp'` or `'Up arrow'`,
-- `'Backspace'`,
-- `'Command'`,
-- `'Control'`,
-- `'Del'`,
-- `'Divide'`,
-- `'End'`,
-- `'Enter'`,
-- `'Equals'`,
-- `'Escape'`,
-- `'F1 to F12'`,
-- `'Home'`,
-- `'Insert'`,
-- `'Meta'`,
-- `'Multiply'`,
-- `'Numpad 0'` to `'Numpad 9'`,
-- `'Pagedown'` or `'PageDown'`,
-- `'Pageup'` or `'PageUp'`,
-- `'Pause'`,
-- `'Semicolon'`,
-- `'Shift'`,
-- `'Space'`,
-- `'Subtract'`,
-- `'Tab'`.
-
-### refreshPage
-
-Reload the current page.
-
-```js
-I.refreshPage();
-```
-
-Returns **void** automatically synchronized promise through #recorder
-
-### resizeWindow
-
-Resize the current window to provided width and height.
-First parameter can be set to `maximize`.
-
-#### Parameters
-
--   `width` **[number][11]** width in pixels or `maximize`.
--   `height` **[number][11]** height in pixels.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### rightClick
-
-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');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** clickable element located by CSS|XPath|strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### saveElementScreenshot
-
-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');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `fileName` **[string][4]** file name to save.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### saveScreenshot
-
-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
-```
-
-#### Parameters
-
--   `fileName` **[string][4]** file name to save.
--   `fullPage` **[boolean][14]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### scrollPageToBottom
-
-Scroll page to the bottom.
-
-```js
-I.scrollPageToBottom();
-```
-
-Returns **void** automatically synchronized promise through #recorder
-
-### scrollPageToTop
-
-Scroll page to the top.
-
-```js
-I.scrollPageToTop();
-```
-
-Returns **void** automatically synchronized promise through #recorder
-
-### scrollTo
-
-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);
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
--   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
--   `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### see
-
-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
-```
-
-#### Parameters
-
--   `text` **[string][4]** expected on page.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeCheckboxIsChecked
-
-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]'});
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeCookie
-
-Checks that cookie with given name exists.
-
-```js
-I.seeCookie('Auth');
-```
-
-#### Parameters
-
--   `name` **[string][4]** cookie name.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeCurrentUrlEquals
-
-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');
-```
-
-#### Parameters
-
--   `url` **[string][4]** value to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeElement
-
-Checks that a given Element is visible
-Element is located by CSS or XPath.
-
-```js
-I.seeElement('#modal');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** located by CSS|XPath|strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeElementInDOM
-
-Checks that a given Element is present in the DOM
-Element is located by CSS or XPath.
-
-```js
-I.seeElementInDOM('#modal');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeInCurrentUrl
-
-Checks that current url contains a provided fragment.
-
-```js
-I.seeInCurrentUrl('/register'); // we are on registration page
-```
-
-#### Parameters
-
--   `url` **[string][4]** a fragment to check
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeInField
-
-Checks that the given input field or textarea equals to given value.
-For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
-
-```js
-I.seeInField('Username', 'davert');
-I.seeInField({css: 'form textarea'},'Type your comment here');
-I.seeInField('form input[type=hidden]','hidden_value');
-I.seeInField('#searchform input','Search');
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** located by label|name|CSS|XPath|strict locator.
--   `value` **([string][4] | [object][5])** value to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeInSource
-
-Checks that the current page contains the given string in its raw source code.
-
-```js
-I.seeInSource('<h1>Green eggs &amp; ham</h1>');
-```
-
-#### Parameters
-
--   `text` **[string][4]** value to check.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeNumberOfVisibleElements
-
-Asserts that an element is visible a given number of times.
-Element is located by CSS or XPath.
-
-```js
-I.seeNumberOfVisibleElements('.buttons', 3);
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][11]** number of elements.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### seeTextEquals
-
-Checks that text is equal to provided one.
-
-```js
-I.seeTextEquals('text', 'h1');
-```
-
-#### Parameters
-
--   `text`  
--   `context`   
-
-### selectOption
-
-Selects an option in a drop-down select.
-Field is searched by label | name | CSS | XPath.
-Option is selected by visible text or by value.
-
-```js
-I.selectOption('Choose Plan', 'Monthly'); // select by label
-I.selectOption('subscription', 'Monthly'); // match option by text
-I.selectOption('subscription', '0'); // or by value
-I.selectOption('//form/select[@name=account]','Premium');
-I.selectOption('form select[name=account]', 'Premium');
-I.selectOption({css: 'form select[name=account]'}, 'Premium');
-```
-
-Provide an array for the second argument to select multiple options.
-
-```js
-I.selectOption('Which OS do you use?', ['Android', 'iOS']);
-```
-
-#### Parameters
-
--   `select` **([string][4] | [object][5])** field located by label|name|CSS|XPath|strict locator.
--   `option` **([string][4] | [Array][12]&lt;any>)** visible text or value of option.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### setCookie
-
-Sets cookie(s).
-
-Can be a single cookie object or an array of cookies:
-
-```js
-I.setCookie({name: 'auth', value: true});
-
-// as array
-I.setCookie([
-  {name: 'auth', value: true},
-  {name: 'agree', value: true}
-]);
-```
-
-#### Parameters
-
--   `cookie` **(Cookie | [Array][12]&lt;Cookie>)** a cookie object or array of cookie objects.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### switchTo
-
-Switches frame or in case of null locator reverts to parent.
-
-```js
-I.switchTo('iframe'); // switch to first iframe
-I.switchTo(); // switch back to main page
-```
-
-#### Parameters
-
--   `locator` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### uncheckOption
-
-Unselects a checkbox or radio button.
-Element is located by label or name or CSS or XPath.
-
-The second parameter is a context (CSS or XPath locator) to narrow the search.
-
-```js
-I.uncheckOption('#agree');
-I.uncheckOption('I Agree to Terms and Conditions');
-I.uncheckOption('agree', '//form');
-```
-
-#### Parameters
-
--   `field` **([string][4] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
--   `context` **([string][4]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### useTestCafeTo
-
-Use [TestCafe][15] API inside a test.
-
-First argument is a description of an action.
-Second argument is async function that gets this helper as parameter.
-
-{ [`t`][16]) } object from TestCafe API is available.
-
-```js
-I.useTestCafeTo('handle browser dialog', async ({ t }) {
-  await t.setNativeDialogHandler(() => true);
-});
-```
-
-#### Parameters
-
--   `description` **[string][4]** used to show in logs.
--   `fn` **[function][8]** async functuion that executed with TestCafe helper as argument
-
-### wait
-
-Pauses execution for a number of seconds.
-
-```js
-I.wait(2); // wait 2 secs
-```
-
-#### Parameters
-
--   `sec` **[number][11]** number of second to wait.
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitForElement
-
-Waits for element to be present on page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForElement('.btn.continue');
-I.waitForElement('.btn.continue', 5); // wait for 5 secs
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitForFunction
-
-Waits for a function to return true (waits for 1 sec by default).
-Running in browser context.
-
-```js
-I.waitForFunction(fn[, [args[, timeout]])
-```
-
-```js
-I.waitForFunction(() => window.requests == 0);
-I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
-I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
-```
-
-#### Parameters
-
--   `fn` **([string][4] | [function][8])** to be executed in browser context.
--   `argsOrSec` **([Array][12]&lt;any> | [number][11])?** (optional, `1` by default) arguments for function or seconds. 
--   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitForInvisible
-
-Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForInvisible('#popup');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitForText
-
-Waits for a text to appear (by default waits for 1sec).
-Element can be located by CSS or XPath.
-Narrow down search results by providing context.
-
-```js
-I.waitForText('Thank you, form has been submitted');
-I.waitForText('Thank you, form has been submitted', 5, '#modal');
-```
-
-#### Parameters
-
--   `text` **[string][4]** to wait for.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
--   `context` **([string][4] | [object][5])?** (optional) element located by CSS|XPath|strict locator. 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitForVisible
-
-Waits for an element to become visible on a page (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForVisible('#popup');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitInUrl
-
-Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
-
-```js
-I.waitInUrl('/info', 2);
-```
-
-#### Parameters
-
--   `urlPart` **[string][4]** value to check.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitNumberOfVisibleElements
-
-Waits for a specified number of elements on the page.
-
-```js
-I.waitNumberOfVisibleElements('a', 3);
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `num` **[number][11]** number of elements.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitToHide
-
-Waits for an element to hide (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitToHide('#popup');
-```
-
-#### Parameters
-
--   `locator` **([string][4] | [object][5])** element located by CSS|XPath|strict locator.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-### waitUrlEquals
-
-Waits for the entire URL to match the expected
-
-```js
-I.waitUrlEquals('/info', 2);
-I.waitUrlEquals('http://127.0.0.1:8000/info');
-```
-
-#### Parameters
-
--   `urlPart` **[string][4]** value to check.
--   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
-
-Returns **void** automatically synchronized promise through #recorder
-
-## getPageUrl
-
-Client Functions
-
-### Parameters
-
--   `t`  
-
-[1]: https://github.com/DevExpress/testcafe
-
-[2]: https://devexpress.github.io/testcafe/documentation/using-testcafe/common-concepts/browsers/browser-support.html
-
-[3]: https://devexpress.github.io/testcafe/documentation/recipes/test-on-remote-computers-and-mobile-devices.html
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[6]: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus
-
-[7]: https://playwright.dev/docs/api/class-locator#locator-blur
-
-[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-
-[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-
-[10]: https://playwright.dev/docs/api/class-locator#locator-focus
-
-[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[13]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/element/:id/value
-
-[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[15]: https://devexpress.github.io/testcafe/documentation/test-api/
-
-[16]: https://devexpress.github.io/testcafe/documentation/test-api/test-code-structure.html#test-controller