codeceptjs 2.3.4 → 2.4.1

package/docs/react.md

@@ -1,8 +1,10 @@
 ---
-id: react
+permalink: /react
 title: Testing React Applications
 ---
 
+# Testing React Applications
+
 React applications require some additional love for end to end testing.
 At first, it is very hard to test an application which was never designed to be tested!
 This happens to many React application. While building components developers often forget to keep the element's semantic.
@@ -34,7 +36,7 @@ However, if you can't update the code you can go to the second option. In this c
 //*[@id="document"]/div[2]/div/div[2]/div
 ```
 
-use [Locator Builder](https://codecept.io/locators#locator-builder) to make clean semantic locator:
+use [Locator Builder](/locators#locator-builder) to make clean semantic locator:
 
 ```js
 locate('[role=tab]').withText('Click Me!');

package/docs/reports.md

@@ -1,8 +1,10 @@
 ---
-id: reports
+permalink: /reports
 title: Reporters
 ---
 
+# Reporters
+
 ## Cli
 
 By default CodeceptJS provides cli reporter with console output.
@@ -157,7 +159,7 @@ Allure requires **Java 8** to work. Then Allure can be installed via NPM:
 npm install -g allure-commandline --save-dev
 ```
 
-Add [Allure plugin](https://codecept.io/plugins/#allure) in config under `plugins` section.
+Add [Allure plugin](/plugins/#allure) in config under `plugins` section.
 
 ```js
 plugins: {
@@ -189,7 +191,7 @@ Launch Allure server and see the report like on a screenshot above:
 allure serve output
 ```
 
-Allure reporter aggregates data from other plugins like [*stepByStepReport*](https://codecept.io/plugins/#stepByStepReport) and [*screenshotOnFail*](https://codecept.io/plugins/#screenshotOnFail)
+Allure reporter aggregates data from other plugins like [*stepByStepReport*](/plugins/#stepByStepReport) and [*screenshotOnFail*](/plugins/#screenshotOnFail)
 
 Allure reports can also be generated for `dry-run` command. So you can get the first report with no tests actually being executed. Enable allure plugin in dry-run options, and pass `--debug` option to print all tests on screen.
 
@@ -231,7 +233,7 @@ Result will be located at `output/result.xml` file.
 
 Best HTML reports could be produced with [mochawesome](https://www.npmjs.com/package/mochawesome) reporter.
 
-![mochawesome](https://codecept.io/img/mochawesome.png)
+![mochawesome](/img/mochawesome.png)
 
 Install it via NPM:
 

package/docs/testcafe.md

@@ -1,9 +1,11 @@
 ---
-id: testcafe
+permalink: /testcafe
 title: Testing with TestCafe
 ---
 
-[TestCafe](https://devexpress.github.io/testcafe/) is another alternative engine for driving browsers. It is driven by unique technology which provides fast and simple cross browser testing for desktop and mobile browsers. Unlike WebDriver or Puppeteer, TestCafe doesn't control a browser at all. It is not a browser itself, like [Nightmare](https://codecept.io/nightmare) or Cypress. **TestCafe core is a proxy server** that runs behind the scene, and transforms all HTML and JS to include code that is needed for test automation.
+# Testing with TestCafe
+
+[TestCafe](https://devexpress.github.io/testcafe/) is another alternative engine for driving browsers. It is driven by unique technology which provides fast and simple cross browser testing for desktop and mobile browsers. Unlike WebDriver or Puppeteer, TestCafe doesn't control a browser at all. It is not a browser itself, like [Nightmare](/nightmare) or Cypress. **TestCafe core is a proxy server** that runs behind the scene, and transforms all HTML and JS to include code that is needed for test automation.
 
 ![](/img/testcafe.png)
 
@@ -25,9 +27,9 @@ Anyway, TestCafe is a good option to start if you need cross browser testing. An
 
 CodeceptJS is a rich testing frameworks which also provides features missing in original TestCafe:
 
-* [Cucumber integration](https://codecept.io/bdd)
-* [Real Page Objects](https://codecept.io/pageobjects)
-* [Data Management via API](https://codecept.io/data)
+* [Cucumber integration](/bdd)
+* [Real Page Objects](/pageobjects)
+* [Data Management via API](/data)
 * and others
 
 ## Writing Tests
@@ -66,9 +68,9 @@ Scenario('create todo item', (I) => {
 });
 ```
 
-Same syntax is the same for all helpers in CodeceptJS so to learn more about available commands learn [CodeceptJS Basics](https://codecept.io/basics).
+Same syntax is the same for all helpers in CodeceptJS so to learn more about available commands learn [CodeceptJS Basics](/basics).
 
-> [▶ Complete list of TestCafe actions](https://codecept.io/helpers/TestCafe)
+> [▶ Complete list of TestCafe actions](/helpers/TestCafe)
 
 ## Page Objects
 
@@ -126,7 +128,7 @@ module.exports = {
 }
 ```
 
-> [▶ Read more about PageObjects in CodeceptJS](https://codecept.io/pageobjects)
+> [▶ Read more about PageObjects in CodeceptJS](/pageobjects)
 
 ## Extending
 

package/docs/translation.md

@@ -1,8 +1,10 @@
 ---
-id: translation
+permalink: /translation
 title: Translation
 ---
 
+# Translation
+
 Test output and the way tests are written can be localized.
 This way scenarios can be written in almost native language using UTF support of JavaScript.
 If you have non-English team and you work on non-English project consider enabling translation
@@ -26,7 +28,7 @@ Add to config:
 
 when running with `--steps` option steps output will be translated:
 
-![steps-in-russian](https://codecept.io/img/translate-ru1.png)
+![steps-in-russian](/img/translate-ru1.png)
 
 This also enables localized method names for actor object.
 

package/docs/ui.md

@@ -0,0 +1,56 @@
+---
+title: CodeceptUI
+layout: Section
+permalink: /ui
+---
+
+
+<img src="/img/codeceptui.png" style="width: 100%; border-radius: 5px; box-shadow: 0px 5px 10px rgba(0,0,0,0.1)" />
+
+
+## CodeceptUI <Badge text="beta" type="warn"/>
+
+CodeceptJS has an interactive, graphical test runner. We call it CodeceptUI. It works in your browser and helps you to manage your tests.
+
+CodeceptUI can be used for
+
+* running tests by groups or single
+* get test reports
+* review tests
+* edit tests and page objects
+* write new tests
+* easily switch to headless/headful mode
+
+CodeceptUI is a useful addon to CodeceptJS, we recommend to try.
+It is an [open-source Vue-based application](https://github.com/codecept-js/ui) which runs in your browser.
+
+> 📺 [Watch CodeceptUI in Action](https://www.youtube.com/watch?v=7pKNVjAckPA)
+
+> 📺 [Watch how to write a new test in CodeceptUI](https://www.youtube.com/watch?v=7P99P5aNnz8)
+
+
+## Using CodeceptUI
+
+To start using CodeceptUI you need to have CodeceptJS project already created with a few tests already written.
+
+Install CodeceptUI via npm
+
+```
+npm i @codeceptjs/ui --save
+```
+
+Execute it:
+
+```
+npx codecept-ui
+```
+
+## Notice
+
+CodeceptUI is in beta. It means that we didn't have a chance to test it for all possible setups.
+You are highly welcome to try it, test it, send issues and **pull requests**.
+
+[Join development team on GitHub!](https://github.com/codecept-js/ui)
+
+
+

package/docs/videos.md

@@ -1,10 +1,19 @@
 ---
-id: videos
+permalink: /videos
+layout: Section
+sidebar: false
 title: Videos
+editLink: false
 ---
 
 > Add your own videos to our [Wiki Page](https://github.com/Codeception/CodeceptJS/wiki/Videos)
-## [Introductory Videos](https://www.youtube.com/watch?v=FPFG1rBNJ64&list=PLcFXthgti9Lt4SjSvL1ALDg6dOeTC0TvT)
+[![](http://i3.ytimg.com/vi/BRMWstiOTks/maxresdefault.jpg)](https://www.youtube.com/watch?v=BRMWstiOTks)
+
+* ## [An Introduction, Getting started and working with CodeceptJS & Puppeteer (EAWeekend)](https://www.youtube.com/watch?v=BRMWstiOTks)
+
+* ## [CodeceptJS Official YouTube Channel](https://www.youtube.com/channel/UCEs4030bmtonyDhTHEXa_2g)
+
+* ## [Introductory Videos](https://www.youtube.com/watch?v=FPFG1rBNJ64&list=PLcFXthgti9Lt4SjSvL1ALDg6dOeTC0TvT)
 
 Free educational videos provided by our community member **[@ontytoom](http://github.com/ontytoom)**.
 

package/docs/visual.md

@@ -1,8 +1,10 @@
 ---
-id: visual
+permalink: /visual
 title: Visual Testing
 ---
 
+# Visual Testing
+
 How does one test if the UI being rendered appears correctly to the users or how to test if each UI element appears in the right position and size? The traditional way to test the UI of the application has always been manually, which is time consuming.
 
 Visual testing with help of CodeceptJS will help in improving such use cases for the QA folks.
@@ -71,18 +73,18 @@ Scenario('Compare CodeceptIO Home Page @visual-test', async (I) => {
 In this example, we are setting the expected mismatch tolerance level as `2`
 
 `Base Image` (Generated by User)
-![Base Image](https://codecept.io/img/Codecept_IO_Base_Image.png)
+![Base Image](/img/Codecept_IO_Base_Image.png)
 
 `Screenshot Image` (Generated by Test)
-![Screenshot Image](https://codecept.io/img/Codecept_IO_Screenshot_Image.png)
+![Screenshot Image](/img/Codecept_IO_Screenshot_Image.png)
 
 Clearly the difference in both the images visible to human eye is the section about `Scenario Driven`
 
-![Difference Image](https://codecept.io/img/difference_Image_Codecept_Home.png)
+![Difference Image](/img/difference_Image_Codecept_Home.png)
 
 `Diff Image` generated by the helper clearly highlights the section which don't match
 
-![Highlight](https://codecept.io/img/Difference%20Image%20Focus.png)
+![Highlight](/img/Difference%20Image%20Focus.png)
 
 `Failed Test output`
 ```

package/docs/vue.md

@@ -0,0 +1,121 @@
+---
+permalink: /vue
+layout: Section
+sidebar: false
+title: Testing Vue Apps
+---
+
+
+# vue-cli-plugin-e2e-codeceptjs
+
+*Hey, how about some end 2 end testing for your Vue apps?* 🤔
+
+*Let's do it together! Vue, me, [CodeceptJS](https://codecept.io) & [Puppeteer](https://pptr.dev).* 🤗
+
+*Browser testing was never that simple. Just see it!* 😍
+
+```js
+I.amOnPage('/');
+I.click('My Component Button');
+I.see('My Component');
+I.say('I am happy!');
+// that's right, this is a valid test!
+```
+
+## How to try it?
+
+**Requirements:**
+
+* NodeJS >= 8.9
+* NPM / Yarn
+* Vue CLI installed globally
+
+```
+npm i vue-cli-plugin-codeceptjs-puppeteer --save-dev
+```
+
+This will install CodeceptJS, CodeceptUI & Puppeteer with Chrome browser.
+
+To add CodeceptJS to your project invoke installer:
+
+```
+vue invoke vue-cli-plugin-codeceptjs-puppeteer
+```
+
+> You will be asked about installing a demo component. If you start a fresh project **it is recommended to agree and install a demo component**, so you could see tests passing.
+
+
+## Running Tests
+
+We added npm scripts:
+
+* `test:e2e` - will execute tests with browser opened. If you installed test component, and started a test server, running this command will show you a brower window passed test.
+  * Use `--headless` option to run browser headlessly
+  * Use `--serve` option to start a dev server before tests
+
+
+Examples:
+
+```
+npm run test:e2e
+npm run test:e2e -- --headless
+npm run test:e2e -- --serve
+```
+
+> This command is a wrapper for `codecept run --steps`. You can use the [Run arguments and options](/commands#run) here.
+
+* `test:e2e:parallel` - will execute tests headlessly in parallel processes (workers). By default runs tests in 2 workers.
+  * Use an argument to set number of workers
+  * Use `--serve` option to start dev server before running
+
+Examples:
+
+```
+npm run test:e2e:parallel
+npm run test:e2e:parallel -- 3
+npm run test:e2e:parallel -- 3 --serve
+```
+
+> This command is a wrapper for `codecept run-workers 2`. You can use the [Run arguments and options](/commands#run-workers) here.
+
+* `test:e2e:open` - this opens interactive web test runner. So you could see, review & run your tests from a browser.
+
+![](https://user-images.githubusercontent.com/220264/70399222-b7a1bc00-1a2a-11ea-8f0b-2878b0328161.gif)
+
+```
+npm run test:e2e:open
+```
+
+## Directory Structure
+
+Generator has created these files:
+
+```js
+codecept.conf.js          👈 codeceptjs config
+jsconfig.json             👈 enabling type definitons
+tests
+├── e2e
+│   ├── app_test.js       👈 demo test, edit it!
+│   ├── output            👈 temp directory for screenshots, reports, etc
+│   └── support
+│       └── steps_file.js 👈 common steps
+└── steps.d.ts            👈 type definitions
+```
+
+If you agreed to create a demo component, you will also see `TestMe` component in `src/components` folder.
+
+## How to write tests?
+
+* Open `tests/e2e/app_js` and see the demo test
+* Execute a test & use interactive pause to see how CodeceptJS works
+* [Learn CodeceptJS basics](/basics)
+* [Learn how to write CodeceptJS tests with Puppeteer](/puppeteer)
+* [See full reference for CodeceptJS Puppeteer Helper](/helpers/Puppeteer)
+* Ask your questions in [Slack](http://bit.ly/chat-codeceptjs) & [Forum](https://codecept.discourse.group/)
+
+## Enjoy testing!
+
+Testing is simple & fun, enjoy it!
+
+With ❤ [CodeceptJS Team](https://codecept.io)
+

package/docs/webapi/appendField.mustache

@@ -4,5 +4,5 @@ Field is located by name, label, CSS or XPath
 ```js
 I.appendField('#myTextField', 'appended');
 ```
-@param {string|object} field located by label|name|CSS|XPath|strict locator
+@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
 @param {string} value text value to append.

package/docs/webapi/attachFile.mustache

@@ -7,5 +7,5 @@ I.attachFile('Avatar', 'data/avatar.jpg');
 I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 ```
 
-@param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
 @param {string} pathToFile local file path relative to codecept.json config file.

package/docs/webapi/checkOption.mustache

@@ -8,5 +8,5 @@ I.checkOption('#agree');
 I.checkOption('I Agree to Terms and Conditions');
 I.checkOption('agree', '//form');
 ```
-@param {string|object} field checkbox located by label | name | CSS | XPath | strict locator.
-@param {string} context (optional, `null` by default) element located by CSS | XPath | strict locator.
+@param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
+@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.

package/docs/webapi/clearCookie.mustache

@@ -6,4 +6,4 @@ I.clearCookie();
 I.clearCookie('test');
 ```
 
-@param {string} cookie (optional, `null` by default) cookie name
+@param {?string} [cookie=null] (optional, `null` by default) cookie name

package/docs/webapi/click.mustache

@@ -20,5 +20,5 @@ I.click('Logout', '#nav');
 I.click({css: 'nav a.login'});
 ```
 
-@param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+@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.

package/docs/webapi/clickLink.mustache

@@ -3,5 +3,5 @@ Performs a click on a link and waits for navigation before moving on.
 ```js
 I.clickLink('Logout', '#nav');
 ```
-@param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
-@param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator
+@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

package/docs/webapi/dontSee.mustache

@@ -7,5 +7,4 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 ```
 
 @param {string} text which is not present.
-@param {string|object} context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-
+@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator in which to perfrom search.

package/docs/webapi/dontSeeCheckboxIsChecked.mustache

@@ -6,4 +6,4 @@ I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
 I.dontSeeCheckboxIsChecked('agree'); // located by name
 ```
 
-@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.

package/docs/webapi/dontSeeElement.mustache

@@ -4,4 +4,4 @@ Opposite to `seeElement`. Checks that element is not visible (or in DOM)
 I.dontSeeElement('.modal'); // modal is not shown
 ```
 
-@param {string|object} locator located by CSS|XPath|Strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.

package/docs/webapi/dontSeeElementInDOM.mustache

@@ -4,4 +4,4 @@ Opposite to `seeElementInDOM`. Checks that element is not on page.
 I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
 ```
 
-@param {string|object} locator located by CSS|XPath|Strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.

package/docs/webapi/dontSeeInField.mustache

@@ -6,5 +6,5 @@ I.dontSeeInField('email', 'user@user.com'); // field by name
 I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 ```
 
-@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
 @param {string} value value to check.

package/docs/webapi/doubleClick.mustache

@@ -8,5 +8,5 @@ I.doubleClick({css: 'button.accept'});
 I.doubleClick('.btn.edit');
 ```
 
-@param {string|object} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
-@param {string|object} context (optional, `null` by default) element to search in CSS|XPath|Strict locator.
+@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.

package/docs/webapi/downloadFile.mustache

@@ -7,5 +7,5 @@ If no custom file name is provided, the default name will be used
 I.downloadFile('td[class="text-right file-link"] a', 'thisIsCustomName');
 ```
 
-@param {string|object} locator clickable link or button located by CSS|XPath locator.
+@param {CodeceptJS.LocatorOrString} locator clickable link or button located by CSS|XPath locator.
 @param {string} file custom file name.

package/docs/webapi/dragSlider.mustache

@@ -6,5 +6,5 @@ I.dragSlider('#slider', 30);
 I.dragSlider('#slider', -70);
 ```
 
-@param {string|object} locator located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by label|name|CSS|XPath|strict locator.
 @param {number} offsetX position to drag.

package/docs/webapi/executeAsyncScript.mustache

@@ -20,4 +20,5 @@ let val = await I.executeAsyncScript(function(url, done) {
 ```
 
 @param {string|function} fn function to be executed in browser context.
-@param ...args args to be passed to function.
+@param {...any} args to be passed to function.
+@return {Promise<any>}

package/docs/webapi/executeScript.mustache

@@ -22,4 +22,5 @@ let date = await I.executeScript(function(el) {
 ```
 
 @param {string|function} fn function to be executed in browser context.
-@param ...args args to be passed to function.
+@param {...any} args to be passed to function.
+@return {Promise<any>}

package/docs/webapi/fillField.mustache

@@ -11,5 +11,5 @@ I.fillField('form#login input[name=username]', 'John');
 // or by strict locator
 I.fillField({css: 'form#login input[name=username]'}, 'John');
 ```
-@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
 @param {string} value text value to fill.

package/docs/webapi/grabAttributeFrom.mustache

@@ -5,6 +5,6 @@ Resumes test execution, so **should be used inside async with `await`** operator
 ```js
 let hint = await I.grabAttributeFrom('#tooltip', 'title');
 ```
-@param {string|object} locator element located by CSS|XPath|strict locator.
+@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

@@ -6,4 +6,4 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
-@returns {Promise<Array>} all browser logs
+@returns {Promise<Array<*>>} all browser logs

package/docs/webapi/grabCookie.mustache

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

package/docs/webapi/grabCssPropertyFrom.mustache

@@ -5,6 +5,6 @@ Resumes test execution, so **should be used inside an async function with `await
 const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 ```
 
-@param {string|object} locator element located by CSS|XPath|strict locator.
+@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/grabHTMLFrom.mustache

@@ -6,5 +6,5 @@ If more than one element is found - an array of HTMLs returned.
 let postHTML = await I.grabHTMLFrom('#post');
 ```
 
-@param locator element located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} element located by CSS|XPath|strict locator.
 @returns {Promise<string>} HTML code for an element

package/docs/webapi/grabNumberOfVisibleElements.mustache

@@ -4,5 +4,5 @@ Grab number of visible elements by locator.
 let numOfElements = await I.grabNumberOfVisibleElements('p');
 ```
 
-@param {string|object} locator located by CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @returns {Promise<number>} number of visible elements

package/docs/webapi/grabPageScrollPosition.mustache

@@ -5,4 +5,4 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-@returns {Promise<object>} scroll position
+@returns {Promise<Object<string, *>>} scroll position

package/docs/webapi/grabTextFrom.mustache

@@ -6,5 +6,5 @@ let pin = await I.grabTextFrom('#pin');
 ```
 If multiple elements found returns an array of texts.
 
-@param locator element located by CSS|XPath|strict locator.
-@returns {Promise<string>} attribute value
+@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
+@returns {Promise<string|string[]>} attribute value

package/docs/webapi/grabValueFrom.mustache

@@ -4,5 +4,5 @@ Resumes test execution, so **should be used inside async function with `await`**
 ```js
 let email = await I.grabValueFrom('input[name=email]');
 ```
-@param {string|object} locator field located by label|name|CSS|XPath|strict locator.
+@param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
 @returns {Promise<string>} attribute value

package/docs/webapi/moveCursorTo.mustache

@@ -6,6 +6,6 @@ I.moveCursorTo('.tooltip');
 I.moveCursorTo('#submit', 5,5);
 ```
 
-@param {string|object} locator located by CSS|XPath|strict locator.
-@param {number} offsetX (optional, `0` by default) X-axis offset.
-@param {number} offsetY (optional, `0` by default) Y-axis offset.
+@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.

package/docs/webapi/pressKey.mustache

@@ -8,4 +8,4 @@ I.pressKey('Enter');
 I.pressKey(['Control','a']);
 ```
 
-@param {string|array} key key or array of keys to press.
+@param {string|string[]} key key or array of keys to press.

package/docs/webapi/pressKeyWithKeyNormalization.mustache

@@ -56,4 +56,4 @@ Some of the supported key names are:
 - `'Space'`
 - `'Tab'`
 
-@param {string|array} key key or array of keys to press.
+@param {string|string[]} key key or array of keys to press.

package/docs/webapi/rightClick.mustache

@@ -9,5 +9,5 @@ I.rightClick('Click me');
 I.rightClick('Click me', '.context');
 ```
 
-@param {string|object} locator clickable element located by CSS|XPath|strict locator.
-@param {string|object} context (optional, `null` by default) element located by CSS|XPath|strict locator.
+@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.

package/docs/webapi/saveScreenshot.mustache

@@ -8,4 +8,4 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 ```
 
 @param {string} fileName file name to save.
-@param {boolean} fullPage (optional, `false` by default) flag to enable fullscreen screenshot mode.
+@param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.

package/docs/webapi/scrollIntoView.mustache

@@ -0,0 +1,10 @@
+Scroll element into viewport.
+
+```js
+I.scrollIntoView('#submit');
+I.scrollIntoView('#submit', true);
+I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
+```
+
+@param {string|object} locator located by CSS|XPath|strict locator.
+@param {boolean|object} alignToTop (optional) or scrollIntoViewOptions (optional), see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.