codeceptjs 2.1.3 → 2.2.1

package/docs/testcafe.md

@@ -0,0 +1,157 @@
+---
+id: 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.
+
+![](/img/testcafe.png)
+
+This is very smart idea. But to use TestCafe on daily basis you need to clearly understand its benefits and limitations:
+
+### Pros
+
+* **Fast**. Browser is controlled from inside a web page. This makes test run inside a browser as fast as your browser can render page with no extra network requests.
+* **Simple Cross-Browser Support.** Because TestCafe only launches browsers, it can **automate browser** on desktop or mobile. Unlike WebDriver, you don't need special version of browser and driver to prepare to run tests. Setup simplified. All you need is just a browser installed, and you are ready to go.
+* **Stable to Execution.** Because a test is executed inside a browser, the network latency effects are reduced. Unlike WebDriver you won't hit stale element exceptions, or element not interactable exceptions, as from within a web browser all DOM elements are accessible.
+
+## Cons
+
+* **Magic.** Browsers executed in TestCafe are not aware that they run in test mode. So at some edges automation control can be broken. It's also quite hard to debug possible issues, as you don't know how actually a web page is parsed to inject automation scripts.
+* **No Browser Control.** Because TestCafe do not control browser, you can't actually automate all users actions. For instance, TestCafe can't open new tabs or open a new browser window in incognito mode. There can be also some issues running tests on 3rd party servers or inside iframes.
+* **Simulated Events.** Events like `click` or `doubleClick` are simulated by JavaScript internally. Inside WebDriver or Puppeteer, where those events are dispatched by a browser, called native events. Native events are closer to real user experience. So in some cases simulated events wouldn't represent actual user experience, which can lead to false positive results. For instance, a button which can't be physically clicked by a user, would be clickable inside TestCafe.
+
+Anyway, TestCafe is a good option to start if you need cross browser testing. And here is the **reason to use TestCafe with CodeceptJS: if you hit an edge case or issue, you can easily switch your tests to WebDriver**. As all helpers in CodeceptJS share the same syntax.
+
+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)
+* and others
+
+## Writing Tests
+
+To start using TestCafe with CodeceptJS install both via NPM
+
+> If you don't have `package.json` in your project, create it with `npm init -y`.
+
+```
+npm i codeceptjs testcafe --save-dev
+```
+
+Then you need to initialize a project, selecting TestCafe when asked:
+
+```
+npx codeceptjs init
+```
+
+A first test should be created with `codeceptjs gt` command
+
+```
+npx codeceptjs gt
+```
+
+In the next example we will [TodoMVC application](http://todomvc.com/examples/angularjs/#/). So let's create a test which will fill in todo list:
+
+```js
+Feature('TodoMVC');
+
+Scenario('create todo item', (I) => {
+  I.amOnPage('http://todomvc.com/examples/angularjs/#/');
+  I.fillField('.new-todo', todo)
+  I.pressKey('Enter');
+  I.seeNumberOfVisibleElements('.todo-list li', 1);
+  I.see('1 item left', '.todo-count');
+});
+```
+
+Same syntax is the same for all helpers in CodeceptJS so to learn more about available commands learn [CodeceptJS Basics](https://codecept.io/basics).
+
+> [▶ Complete list of TestCafe actions](https://codecept.io/helpers/TestCafe)
+
+## Page Objects
+
+Multiple tests can be refactored to share some logic and locators. It is recommended to use PageObjects for this. For instance, in example above, we could create special actions for creating todos and checking them. If we move such methods in a corresponding object a test would look even clearer:
+
+```js
+Scenario('Create a new todo item', async (I, TodosPage) => {
+  I.say('Given I have an empty todo list')
+
+  I.say('When I create a todo "foo"')
+  TodosPage.enterTodo('foo')
+
+  I.say('Then I see the new todo on my list')
+  TodosPage.seeNumberOfTodos(1)
+
+  I.saveScreenshot('create-todo-item.png')
+})
+
+Scenario('Create multiple todo items', async (I, TodosPage) => {
+  I.say('Given I have an empty todo list')
+
+  I.say('When I create todos "foo", "bar" and "baz"')
+  TodosPage.enterTodo('foo')
+  TodosPage.enterTodo('bar')
+  TodosPage.enterTodo('baz')
+
+  I.say('Then I have these 3 todos on my list')
+  TodosPage.seeNumberOfTodos(3)
+
+  I.saveScreenshot('create-multiple-todo-items.png')
+})
+```
+
+> ℹ [Source code of this example](https://github.com/hubidu/codeceptjs-testcafe-todomvc) is available on GitHub.
+
+A PageObject can be injected into a test by its name. Here is how TodosPage looks like:
+
+```js
+// inside todos_page.js
+const { I } = inject();
+
+module.exports = {
+    goto() {
+        I.amOnPage('http://todomvc.com/examples/angularjs/#/')
+    },
+
+    enterTodo(todo) {
+        I.fillField('.new-todo', todo)
+        I.pressKey('Enter')
+    },
+
+    seeNumberOfTodos(numberOfTodos) {
+        I.seeNumberOfVisibleElements('.todo-list li', numberOfTodos)
+    },
+}
+```
+
+> [▶ Read more about PageObjects in CodeceptJS](https://codecept.io/pageobjects)
+
+## Extending
+
+If you want to use TestCafe API inside your tests you can put them into actions of `I` object. To do so you can generate a new helper, access TestCafe helper, and get the test controller.
+
+Create a helper using `codecepjs gh` command.
+
+```
+npx codeceptjs gh
+```
+
+All methods of newly created class will be added to `I` object.
+
+```js
+const Helper = codeceptjs.helper;
+
+class MyTestCafe extends Helper {
+
+  slowlyFillField(field, text) {
+    // import test controller from TestCafe helper
+    const { t } = this.helpers.TestCafe;
+    // use TestCafe API here
+    return t.setTestSpeed(0.1)
+        .typeText(field, text);
+  }
+
+}
+```

package/docs/videos.md

@@ -0,0 +1,19 @@
+---
+id: videos
+title: Videos
+---
+
+> 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)
+
+Free educational videos provided by our community member **[@ontytoom](http://github.com/ontytoom)**.
+
+1. [Installation](https://www.youtube.com/watch?v=FPFG1rBNJ64)
+1. [Creating a Test](https://www.youtube.com/watch?v=mdQZjL3h9d0)
+1. [Using Page Objects](https://www.youtube.com/watch?v=s677_6VctjQ)
+
+## [Practical E2E Testing with CodeceptJS](https://www.udemy.com/practical-e2e-testing-with-codeceptjs/)
+
+Udemy course by Luke Beilharz
+
+

package/docs/webapi/amOnPage.mustache

@@ -7,4 +7,4 @@ I.amOnPage('https://github.com'); // opens github
 I.amOnPage('/login'); // opens a login page
 ```
 
-@param url url path or global url.
+@param {string} url url path or global url.

package/docs/webapi/appendField.mustache

@@ -4,5 +4,5 @@ Field is located by name, label, CSS or XPath
 ```js
 I.appendField('#myTextField', 'appended');
 ```
-@param field located by label|name|CSS|XPath|strict locator
-@param value text value to append.
+@param {string|object} 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 locator field located by label|name|CSS|XPath|strict locator.
-@param pathToFile local file path relative to codecept.json config file.
+@param {string|object} 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 field checkbox located by label | name | CSS | XPath | strict locator.
-@param context (optional) element located by CSS | XPath | strict locator.
+@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.

package/docs/webapi/clearCookie.mustache

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

package/docs/webapi/clearField.mustache

@@ -5,4 +5,4 @@ I.clearField('Email');
 I.clearField('user[email]');
 I.clearField('#email');
 ```
-@param field located by label|name|CSS|XPath|strict locator.
+@param {string|object} editable field located by label|name|CSS|XPath|strict locator.

package/docs/webapi/click.mustache

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

package/docs/webapi/clickLink.mustache

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

package/docs/webapi/dontSee.mustache

@@ -2,7 +2,10 @@ 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'); // assume we are already logged in.
+I.dontSee('Login', '.nav'); // no login inside .nav element
 ```
-@param text is not present.
-@param context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+
+@param {string} text which is not present.
+@param {string|object} context (optional) element located by CSS|XPath|strict locator in which to perfrom search.
+

package/docs/webapi/dontSeeCheckboxIsChecked.mustache

@@ -1,3 +1,9 @@
 Verifies that the specified checkbox is not checked.
 
-@param field located by label|name|CSS|XPath|strict locator.
+```js
+I.dontSeeeCheckboxIsChedcked('#agree'); // located by ID
+I.dontSeeeCheckboxIsChedcked('I agree to terms'); // located by label
+I.dontSeeeCheckboxIsChedcked('agree'); // located by name
+```
+
+@param {string|object} field located by label|name|CSS|XPath|strict locator.

package/docs/webapi/dontSeeCookie.mustache

@@ -1,3 +1,7 @@
 Checks that cookie with given name does not exist.
 
-@param name cookie name.
+```js
+I.dontSeeCookie('auth'); // no auth cookie
+```
+
+@param {string} name cookie name.

package/docs/webapi/dontSeeCurrentUrlEquals.mustache

@@ -1,4 +1,9 @@
 Checks that current url is not equal to provided one.
 If a relative url provided, a configured url will be prepended to it.
 
-@param url value to check.
+```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.

package/docs/webapi/dontSeeElement.mustache

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

package/docs/webapi/dontSeeElementInDOM.mustache

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

package/docs/webapi/dontSeeInCurrentUrl.mustache

@@ -1,3 +1,3 @@
 Checks that current url does not contain a provided fragment.
 
-@param url value to check.
+@param {string} url value to check.

package/docs/webapi/dontSeeInField.mustache

@@ -1,5 +1,10 @@
 Checks that value of input field or textare doesn't equal to given value
 Opposite to `seeInField`.
 
-@param field located by label|name|CSS|XPath|strict locator.
-@param value value to check.
+```js
+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 {string} value value to check.

package/docs/webapi/dontSeeInSource.mustache

@@ -1,3 +1,7 @@
 Checks that the current page does not contains the given string in its raw source code.
 
-@param text value to check.
+```js
+I.dontSeeInSource('<!--'); // no comments in source
+```
+
+@param {string} value to check.

package/docs/webapi/dontSeeInTitle.mustache

@@ -1,3 +1,7 @@
 Checks that title does not contain text.
 
-@param text text value to check.
+```js
+I.dontSeeInTitle('Error');
+```
+
+@param {string} text value to check.

package/docs/webapi/doubleClick.mustache

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

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 locator clickable link or button located by CSS|XPath locator.
-@param string custom file name.
+@param {string|object} locator clickable link or button located by CSS|XPath locator.
+@param {string} file custom file name.

package/docs/webapi/dragAndDrop.mustache

@@ -4,5 +4,5 @@ Drag an item to a destination element.
 I.dragAndDrop('#dragHandle', '#container');
 ```
 
-@param srcElement located by CSS|XPath|strict locator.
-@param destElement located by CSS|XPath|strict locator.
+@param {string|object} srcElement located by CSS|XPath|strict locator.
+@param {string|object} destElement located by CSS|XPath|strict locator.

package/docs/webapi/dragSlider.mustache

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

package/docs/webapi/executeAsyncScript.mustache

@@ -19,5 +19,5 @@ let val = await I.executeAsyncScript(function(url, done) {
 }, 'http://ajax.callback.url/');
 ```
 
-@param fn function to be executed in browser context.
+@param {string|function} fn function to be executed in browser context.
 @param ...args args to be passed to function.

package/docs/webapi/executeScript.mustache

@@ -21,5 +21,5 @@ let date = await I.executeScript(function(el) {
 }, '#date'); // passing jquery selector
 ```
 
-@param fn function to be executed in browser context.
+@param {string|function} fn function to be executed in browser context.
 @param ...args args to be passed to function.

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 field located by label|name|CSS|XPath|strict locator.
-@param value text value to fill.
+@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {string} value text value to fill.

package/docs/webapi/grabAttributeFrom.mustache

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

package/docs/webapi/grabBrowserLogs.mustache

@@ -4,4 +4,6 @@ Resumes test execution, so **should be used inside an async function with `await
 ```js
 let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
-```
+```
+
+@returns {Promise<Array>} all browser logs

package/docs/webapi/grabCookie.mustache

@@ -7,4 +7,5 @@ let cookie = await I.grabCookie('auth');
 assert(cookie.value, '123456');
 ```
 
-@param name (optional) cookie name.
+@param [name=null] cookie name.
+@returns {Promise<string>} attribute value

package/docs/webapi/grabCssPropertyFrom.mustache

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

package/docs/webapi/grabCurrentUrl.mustache

@@ -4,4 +4,6 @@ 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/grabDataFromPerformanceTiming.mustache

@@ -0,0 +1,19 @@
+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
+}
+```

package/docs/webapi/grabHTMLFrom.mustache

@@ -6,4 +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 locator element located by CSS|XPath|strict locator.
+@returns {Promise<string>} HTML code for an element

package/docs/webapi/grabNumberOfOpenTabs.mustache

@@ -1,5 +1,7 @@
 Grab number of open tabs.
 
 ```js
-I.grabNumberOfOpenTabs();
-```
+let tabs = await I.grabNumberOfOpenTabs();
+```
+
+@returns {Promise<number>} number of open tabs

package/docs/webapi/grabNumberOfVisibleElements.mustache

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

package/docs/webapi/grabPageScrollPosition.mustache

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

package/docs/webapi/grabSource.mustache

@@ -3,4 +3,6 @@ Resumes test execution, so should be used inside an async function.
 
 ```js
 let pageSource = await I.grabSource();
-```
+```
+
+@returns {Promise<string>} source code

package/docs/webapi/grabTextFrom.mustache

@@ -6,4 +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.
+@param locator element located by CSS|XPath|strict locator.
+@returns {Promise<string>} attribute value

package/docs/webapi/grabTitle.mustache

@@ -3,4 +3,6 @@ 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

@@ -4,4 +4,5 @@ Resumes test execution, so **should be used inside async function with `await`**
 ```js
 let email = await I.grabValueFrom('input[name=email]');
 ```
-@param locator field located by label|name|CSS|XPath|strict locator.
+@param {string|object} 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 locator located by CSS|XPath|strict locator.
-@param offsetX (optional) X-axis offset.
-@param offsetY (optional) Y-axis offset.
+@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.

package/docs/webapi/pressKey.mustache

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

package/docs/webapi/resizeWindow.mustache

@@ -1,5 +1,5 @@
 Resize the current window to provided width and height.
 First parameter can be set to `maximize`.
 
-@param width width in pixels or `maximize`.
-@param height height in pixels.
+@param {number} width width in pixels or `maximize`.
+@param {number} height height in pixels.

package/docs/webapi/rightClick.mustache

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

package/docs/webapi/saveScreenshot.mustache

@@ -1,5 +1,5 @@
 Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-Filename is relative to output folder. 
+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
@@ -7,5 +7,5 @@ I.saveScreenshot('debug.png');
 I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
 ```
 
-@param fileName file name to save. 
-@param fullPage (optional) flag to enable fullscreen screenshot mode.
+@param {string} fileName file name to save.
+@param {boolean} fullPage (optional, `false` by default) flag to enable fullscreen screenshot mode.

package/docs/webapi/say.mustache

@@ -5,5 +5,5 @@ 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 text expected on console log.
-@param text (optional) color you want to use.
+@param {string} text expected on console log.
+@param {string} [color='cyan'] color you want to use.

package/docs/webapi/scrollPageToBottom.mustache

@@ -2,4 +2,4 @@ Scroll page to the bottom.
 
 ```js
 I.scrollPageToBottom();
-```
+```

package/docs/webapi/scrollPageToTop.mustache

@@ -2,4 +2,4 @@ Scroll page to the top.
 
 ```js
 I.scrollPageToTop();
-```
+```