codeceptjs 3.5.0 → 3.5.1-2.beta.7

package/docs/webapi/clickLink.mustache

@@ -1,8 +0,0 @@
-Performs a click on a link and waits for navigation before moving on.
-
-```js
-I.clickLink('Logout', '#nav');
-```
-@param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/closeCurrentTab.mustache

@@ -1,7 +0,0 @@
-Close current tab.
-
-```js
-I.closeCurrentTab();
-```
-
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/closeOtherTabs.mustache

@@ -1,8 +0,0 @@
-Close all tabs except for the current one.
-
-
-```js
-I.closeOtherTabs();
-```
-
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSee.mustache

@@ -1,11 +0,0 @@
-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
-```
-
-@param {string} text which is not present.
-@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeCheckboxIsChecked.mustache

@@ -1,10 +0,0 @@
-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
-```
-
-@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeCookie.mustache

@@ -1,8 +0,0 @@
-Checks that cookie with given name does not exist.
-
-```js
-I.dontSeeCookie('auth'); // no auth cookie
-```
-
-@param {string} name cookie name.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeCurrentUrlEquals.mustache

@@ -1,10 +0,0 @@
-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
-```
-
-@param {string} url value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeElement.mustache

@@ -1,8 +0,0 @@
-Opposite to `seeElement`. Checks that element is not visible (or in DOM)
-
-```js
-I.dontSeeElement('.modal'); // modal is not shown
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeElementInDOM.mustache

@@ -1,8 +0,0 @@
-Opposite to `seeElementInDOM`. Checks that element is not on page.
-
-```js
-I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInCurrentUrl.mustache

@@ -1,4 +0,0 @@
-Checks that current url does not contain a provided fragment.
-
-@param {string} url value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInField.mustache

@@ -1,11 +0,0 @@
-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
-```
-
-@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {string} value value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInSource.mustache

@@ -1,8 +0,0 @@
-Checks that the current page does not contains the given string in its raw source code.
-
-```js
-I.dontSeeInSource('<!--'); // no comments in source
-```
-
-@param {string} value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dontSeeInTitle.mustache

@@ -1,8 +0,0 @@
-Checks that title does not contain text.
-
-```js
-I.dontSeeInTitle('Error');
-```
-
-@param {string} text value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/doubleClick.mustache

@@ -1,13 +0,0 @@
-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');
-```
-
-@param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/downloadFile.mustache

@@ -1,12 +0,0 @@
-Performs a download file on an element matched by link|button|CSS or XPath.
-File is downloaded by default to output folder.
-If no custom file name is provided, the default name will be used
-
-
-```js
-I.downloadFile('td[class="text-right file-link"] a', 'thisIsCustomName');
-```
-
-@param {CodeceptJS.LocatorOrString} locator clickable link or button located by CSS|XPath locator.
-@param {string} file custom file name.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dragAndDrop.mustache

@@ -1,9 +0,0 @@
-Drag an item to a destination element.
-
-```js
-I.dragAndDrop('#dragHandle', '#container');
-```
-
-@param {LocatorOrString} srcElement located by CSS|XPath|strict locator.
-@param {LocatorOrString} destElement located by CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/dragSlider.mustache

@@ -1,11 +0,0 @@
-Drag the scrubber of a slider to a given position
-For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
-
-```js
-I.dragSlider('#slider', 30);
-I.dragSlider('#slider', -70);
-```
-
-@param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
-@param {number} offsetX position to drag.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/executeAsyncScript.mustache

@@ -1,24 +0,0 @@
-Executes async script on page.
-Provided function should execute a passed callback (as first argument) to signal it is finished.
-
-Example: In Vue.js to make components completely rendered we are waiting for [nextTick](https://vuejs.org/v2/api/#Vue-nextTick).
-
-```js
-I.executeAsyncScript(function(done) {
-  Vue.nextTick(done); // waiting for next tick
-});
-```
-
-By passing value to `done()` function you can return values.
-Additional arguments can be passed as well, while `done` function is always last parameter in arguments list.
-
-```js
-let val = await I.executeAsyncScript(function(url, done) {
-  // in browser context
-  $.ajax(url, { success: (data) => done(data); }
-}, 'http://ajax.callback.url/');
-```
-
-@param {string|function} fn function to be executed in browser context.
-@param {...any} args to be passed to function.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/executeScript.mustache

@@ -1,26 +0,0 @@
-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
-```
-
-@param {string|function} fn function to be executed in browser context.
-@param {...any} args to be passed to function.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/fillField.mustache

@@ -1,16 +0,0 @@
-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');
-```
-@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {CodeceptJS.StringOrSecret} value text value to fill.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/forceClick.mustache

@@ -1,28 +0,0 @@
-Perform an emulated click on a link or a button, given by a locator.
-Unlike normal click instead of sending native event, emulates a click with JavaScript.
-This works on hidden, animated or inactive elements as well.
-
-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.forceClick('Logout');
-// button of form
-I.forceClick('Submit');
-// CSS button
-I.forceClick('#form input[type=submit]');
-// XPath
-I.forceClick('//form/*[@type=submit]');
-// link in context
-I.forceClick('Logout', '#nav');
-// using strict locator
-I.forceClick({css: 'nav a.login'});
-```
-
-@param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/forceRightClick.mustache

@@ -1,18 +0,0 @@
-Emulates right click on an element.
-Unlike normal click instead of sending native event, emulates a click with JavaScript.
-This works on hidden, animated or inactive elements as well.
-
-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.forceRightClick('Menu');
-```
-
-@param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/grabAllWindowHandles.mustache

@@ -1,7 +0,0 @@
-Get all Window Handles.
-Useful for referencing a specific handle when calling `I.switchToWindow(handle)`
-
-```js
-const windows = await I.grabAllWindowHandles();
-```
-@returns {Promise<string[]>}

package/docs/webapi/grabAttributeFrom.mustache

@@ -1,10 +0,0 @@
-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');
-```
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {string} attr attribute name.
-@returns {Promise<string>} attribute value

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 {Promise<string>|Promise<string[]>} 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
-}
-```
-@return {Promise<any>} 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/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/moveCursorTo.mustache

@@ -1,12 +0,0 @@
-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);
-```
-
-@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 a _promise_ which is synchronized internally by recorder

package/docs/webapi/openNewTab.mustache

@@ -1,7 +0,0 @@
-Open new tab and switch to it.
-
-```js
-I.openNewTab();
-```
-
-⚠️ returns a _promise_ which is synchronized internally by 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 a _promise_ which is synchronized internally by 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 a _promise_ which is synchronized internally by 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 a _promise_ which is synchronized internally by recorder