codeceptjs 2.1.3 → 2.2.1

package/docs/webapi/scrollTo.mustache

@@ -6,6 +6,6 @@ I.scrollTo('footer');
 I.scrollTo('#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/see.mustache

@@ -6,5 +6,5 @@ I.see('Welcome'); // text welcome on a page
 I.see('Welcome', '.content'); // text inside .content div
 I.see('Register', {css: 'form.register'}); // use strict locator
 ```
-@param text expected on page.
-@param context (optional) element located by CSS|Xpath|strict locator in which to search for text.
+@param {string} text expected on page.
+@param {string|object} context (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.

package/docs/webapi/seeAttributesOnElements.mustache

@@ -1,8 +1,8 @@
 Checks that all elements with given locator have given attributes.
 
 ```js
-I.seeAttributesOnElements('//form', {'method': "post"});
+I.seeAttributesOnElements('//form', { method: "post"});
 ```
 
-@param locator located by CSS|XPath|strict locator.
-@param attributes object with attributes and their values to check.
+@param {string|object} locator located by CSS|XPath|strict locator.
+@param {object} attributes attributes and their values to check.

package/docs/webapi/seeCheckboxIsChecked.mustache

@@ -5,4 +5,5 @@ I.seeCheckboxIsChecked('Agree');
 I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
 I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 ```
-@param field located by label|name|CSS|XPath|strict locator.
+
+@param {string|object} field located by label|name|CSS|XPath|strict locator.

package/docs/webapi/seeCookie.mustache

@@ -4,4 +4,4 @@ Checks that cookie with given name exists.
 I.seeCookie('Auth');
 ```
 
-@param name cookie name.
+@param {string} name cookie name.

package/docs/webapi/seeCssPropertiesOnElements.mustache

@@ -4,5 +4,5 @@ Checks that all elements with given locator have given CSS properties.
 I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 ```
 
-@param locator located by CSS|XPath|strict locator.
-@param cssProperties object with CSS properties and their values to check.
+@param {string|object} locator located by CSS|XPath|strict locator.
+@param {object} cssProperties object with CSS properties and their values to check.

package/docs/webapi/seeCurrentUrlEquals.mustache

@@ -7,4 +7,4 @@ I.seeCurrentUrlEquals('/register');
 I.seeCurrentUrlEquals('http://my.site.com/register');
 ```
 
-@param url value to check.
+@param {string} url value to check.

package/docs/webapi/seeElement.mustache

@@ -4,4 +4,4 @@ Element is located by CSS or XPath.
 ```js
 I.seeElement('#modal');
 ```
-@param locator located by CSS|XPath|strict locator.
+@param {string|object} locator located by CSS|XPath|strict locator.

package/docs/webapi/seeElementInDOM.mustache

@@ -4,4 +4,4 @@ Element is located by CSS or XPath.
 ```js
 I.seeElementInDOM('#modal');
 ```
-@param locator located by CSS|XPath|strict locator.
+@param {string|object} locator element located by CSS|XPath|strict locator.

package/docs/webapi/seeInCurrentUrl.mustache

@@ -4,4 +4,4 @@ Checks that current url contains a provided fragment.
 I.seeInCurrentUrl('/register'); // we are on registration page
 ```
 
-@param url value to check.
+@param {string} url a fragment to check

package/docs/webapi/seeInField.mustache

@@ -7,5 +7,5 @@ I.seeInField({css: 'form textarea'},'Type your comment here');
 I.seeInField('form input[type=hidden]','hidden_value');
 I.seeInField('#searchform input','Search');
 ```
-@param field located by label|name|CSS|XPath|strict locator.
-@param value value to check.
+@param {string|object} field located by label|name|CSS|XPath|strict locator.
+@param {string} value value to check.

package/docs/webapi/seeInSource.mustache

@@ -3,4 +3,4 @@ Checks that the current page contains the given string in its raw source code.
 ```js
 I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 ```
-@param text value to check.
+@param {string} text value to check.

package/docs/webapi/seeInTitle.mustache

@@ -1,3 +1,7 @@
 Checks that title contains text.
 
-@param text text value to check.
+```js
+I.seeInTitle('Home Page');
+```
+
+@param {string} text text value to check.

package/docs/webapi/seeNumberOfElements.mustache

@@ -0,0 +1,10 @@
+Asserts that an element appears a given number of times in the DOM.
+Element is located by label or name or CSS or XPath.
+
+
+```js
+I.seeNumberOfElements('#submitBtn', 1);
+```
+
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} num number of elements.

package/docs/webapi/seeNumberOfVisibleElements.mustache

@@ -5,5 +5,5 @@ Element is located by CSS or XPath.
 I.seeNumberOfVisibleElements('.buttons', 3);
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param num number of elements.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} num number of elements.

package/docs/webapi/selectOption.mustache

@@ -16,5 +16,5 @@ Provide an array for the second argument to select multiple options.
 ```js
 I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 ```
-@param select field located by label|name|CSS|XPath|strict locator.
-@param option visible text or value of option.
+@param {string|object} select field located by label|name|CSS|XPath|strict locator.
+@param {string|array} option visible text or value of option.

package/docs/webapi/setCookie.mustache

@@ -4,4 +4,4 @@ Sets a cookie.
 I.setCookie({name: 'auth', value: true});
 ```
 
-@param cookie cookie JSON object.
+@param {object} cookie a cookie object.

package/docs/webapi/switchTo.mustache

@@ -1,3 +1,8 @@
 Switches frame or in case of null locator reverts to parent.
 
-@param locator element located by CSS|XPath|strict locator.
+```js
+I.switchTo('iframe'); // switch to first iframe
+I.switchTo(); // switch back to main page
+```
+
+@param {string|object} locator (optional, `null` by default) element located by CSS|XPath|strict locator.

package/docs/webapi/uncheckOption.mustache

@@ -8,5 +8,5 @@ I.uncheckOption('#agree');
 I.uncheckOption('I Agree to Terms and Conditions');
 I.uncheckOption('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/wait.mustache

@@ -4,5 +4,4 @@ Pauses execution for a number of seconds.
 I.wait(2); // wait 2 secs
 ```
 
-@param sec number of second to wait.
-@param sec time in seconds to wait.
+@param {number} sec number of second to wait.

package/docs/webapi/waitForDetached.mustache

@@ -1,9 +1,9 @@
 Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-```
+```js
 I.waitForDetached('#popup');
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForElement.mustache

@@ -6,5 +6,5 @@ I.waitForElement('.btn.continue');
 I.waitForElement('.btn.continue', 5); // wait for 5 secs
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForEnabled.mustache

@@ -1,5 +1,5 @@
 Waits for element to become enabled (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-@param locator element located by CSS|XPath|strict locator.
+@param {string|object} locator element located by CSS|XPath|strict locator.
 @param sec (optional) time in seconds to wait, 1 by default.

package/docs/webapi/waitForFunction.mustache

@@ -11,6 +11,6 @@ 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
 ```
 
-@param fn to be executed in browser context.
-@param argsOrSec (optional) arguments for function or seconds.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {string|function} fn to be executed in browser context.
+@param {array|number} argsOrSec (optional, `1` by default) arguments for function or seconds.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForInvisible.mustache

@@ -1,9 +1,9 @@
 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');
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForText.mustache

@@ -7,6 +7,6 @@ I.waitForText('Thank you, form has been submitted');
 I.waitForText('Thank you, form has been submitted', 5, '#modal');
 ```
 
-@param text to wait for.
-@param sec (optional) time in seconds to wait.
-@param context (optional) element located by CSS|XPath|strict locator.
+@param {string }text to wait for.
+@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {string|object} context (optional) element located by CSS|XPath|strict locator.

package/docs/webapi/waitForValue.mustache

@@ -4,6 +4,6 @@ Waits for the specified value to be in value attribute.
 I.waitForValue('//input', "GoodValue");
 ```
 
-@param field input field.
-@param value expected value.
-@param sec (optional) time in seconds to wait, 1 sec by default.
+@param {string|object} field input field.
+@param {string }value expected value.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitForVisible.mustache

@@ -1,9 +1,9 @@
 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');
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitInUrl.mustache

@@ -4,5 +4,5 @@ Waiting for the part of the URL to match the expected. Useful for SPA to underst
 I.waitInUrl('/info', 2);
 ```
 
-@param urlPart value to check.
-@param sec (optional) time in seconds to wait.
+@param {string} urlPart value to check.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -4,6 +4,6 @@ Waits for a specified number of elements on the page.
 I.waitNumberOfVisibleElements('a', 3);
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param num number of elements.
-@param sec (optional) time in seconds to wait.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} num number of elements.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitToHide.mustache

@@ -1,9 +1,9 @@
 Waits for an element to hide (by default waits for 1sec).
 Element can be located by CSS or XPath.
 
-```
+```js
 I.waitToHide('#popup');
 ```
 
-@param locator element located by CSS|XPath|strict locator.
-@param sec (optional) time in seconds to wait, 1 by default.
+@param {string|object} locator element located by CSS|XPath|strict locator.
+@param {number} sec (optional, `1` by default) time in seconds to wait

package/docs/webapi/waitUntil.mustache

@@ -5,6 +5,6 @@ I.waitUntil(() => window.requests == 0);
 I.waitUntil(() => window.requests == 0, 5);
 ```
 
-@param fn function which is executed in browser context.
-@param sec (optional) time in seconds to wait, 1 by default.
-@param timeoutMsg (optional) message to show in case of timeout fail.
+@param {function|string} fn function which is executed in browser context.
+@param {number} sec (optional, `1` by default) time in seconds to wait
+@param {string} [timeoutMsg=''] message to show in case of timeout fail.

package/docs/webapi/waitUrlEquals.mustache

@@ -5,5 +5,5 @@ I.waitUrlEquals('/info', 2);
 I.waitUrlEquals('http://127.0.0.1:8000/info');
 ```
 
-@param urlPart value to check.
-@param sec (optional) time in seconds to wait.
+@param {string} urlPart value to check.
+@param {number} sec (optional, `1` by default) time in seconds to wait