codeceptjs 4.0.0-rc.17 → 4.0.0-rc.19

package/docs/webapi/seeInField.mustache

@@ -1,17 +0,0 @@
-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.
-
-The third parameter is an optional context (CSS or XPath locator) to narrow the search.
-
-```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');
-// within a context
-I.seeInField('Name', 'John', '.form-container');
-```
-@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {CodeceptJS.StringOrSecret} value value to check.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeInPopup.mustache

@@ -1,8 +0,0 @@
-Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
-given string.
-
-```js
-I.seeInPopup('Popup text');
-```
-@param {string} text value to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeInSource.mustache

@@ -1,7 +0,0 @@
-Checks that the current page contains the given string in its raw source code.
-
-```js
-I.seeInSource('<h1>Green eggs &amp; ham</h1>');
-```
-@param {string} text value to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeInTitle.mustache

@@ -1,8 +0,0 @@
-Checks that title contains text.
-
-```js
-I.seeInTitle('Home Page');
-```
-
-@param {string} text text value to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeNumberOfElements.mustache

@@ -1,11 +0,0 @@
-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 {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} num number of elements.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeNumberOfVisibleElements.mustache

@@ -1,10 +0,0 @@
-Asserts that an element is visible a given number of times.
-Element is located by CSS or XPath.
-
-```js
-I.seeNumberOfVisibleElements('.buttons', 3);
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} num number of elements.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeTextEquals.mustache

@@ -1,9 +0,0 @@
-Checks that text is equal to provided one.
-
-```js
-I.seeTextEquals('text', 'h1');
-```
-
-@param {string} text element value to check.
-@param {CodeceptJS.LocatorOrString?} [context=null]  element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeTitleEquals.mustache

@@ -1,8 +0,0 @@
-Checks that title is equal to provided one.
-
-```js
-I.seeTitleEquals('Test title.');
-```
-
-@param {string} text value to check.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/seeTraffic.mustache

@@ -1,36 +0,0 @@
-Verifies that a certain request is part of network traffic.
-
-```js
-// checking the request url contains certain query strings
-I.amOnPage('https://openai.com/blog/chatgpt');
-I.startRecordingTraffic();
-await I.seeTraffic({
-    name: 'sentry event',
-    url: 'https://images.openai.com/blob/cf717bdb-0c8c-428a-b82b-3c3add87a600',
-    parameters: {
-    width: '1919',
-    height: '1138',
-    },
-  });
-```
-
-```js
-// checking the request url contains certain post data
-I.amOnPage('https://openai.com/blog/chatgpt');
-I.startRecordingTraffic();
-await I.seeTraffic({
-    name: 'event',
-    url: 'https://cloudflareinsights.com/cdn-cgi/rum',
-    requestPostData: {
-    st: 2,
-    },
-  });
-```
-
-@param {Object} opts - options when checking the traffic network.
-@param {string} opts.name A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
-@param {string} opts.url Expected URL of request in network traffic
-@param {Object} [opts.parameters] Expected parameters of that request in network traffic
-@param {Object} [opts.requestPostData] Expected that request contains post data in network traffic
-@param {number} [opts.timeout] Timeout to wait for request in seconds. Default is 10 seconds.
-@return {void} automatically synchronized promise through #recorder

package/docs/webapi/selectOption.mustache

@@ -1,26 +0,0 @@
-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.
-
-The third parameter is an optional context (CSS or XPath locator) to narrow the search.
-
-```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');
-// within a context
-I.selectOption('age', '21-60', '#section2');
-```
-
-Provide an array for the second argument to select multiple options.
-
-```js
-I.selectOption('Which OS do you use?', ['Android', 'iOS']);
-```
-@param {LocatorOrString} select field located by label|name|CSS|XPath|strict locator.
-@param {string|Array<*>} option visible text or value of option.
-@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/setCookie.mustache

@@ -1,16 +0,0 @@
-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}
-]);
-```
-
-@param {Cookie|Array<Cookie>} cookie a cookie object or array of cookie objects.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/setGeoLocation.mustache

@@ -1,12 +0,0 @@
-Set the current geo location
-
-
-```js
-I.setGeoLocation(121.21, 11.56);
-I.setGeoLocation(121.21, 11.56, 10);
-```
-
-@param {number} latitude to set.
-@param {number} longitude to set
-@param {number=} altitude (optional, null by default) to set
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/startRecordingTraffic.mustache

@@ -1,8 +0,0 @@
-Starts recording the network traffics.
-This also resets recorded network requests.
-
-```js
-I.startRecordingTraffic();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/startRecordingWebSocketMessages.mustache

@@ -1,8 +0,0 @@
-Starts recording of websocket messages.
-This also resets recorded websocket messages.
-
-```js
-await I.startRecordingWebSocketMessages();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/stopRecordingTraffic.mustache

@@ -1,5 +0,0 @@
-Stops recording of network traffic. Recorded traffic is not flashed.
-
-```js
-I.stopRecordingTraffic();
-```

package/docs/webapi/stopRecordingWebSocketMessages.mustache

@@ -1,7 +0,0 @@
-Stops recording WS messages. Recorded WS messages is not flashed.
-
-```js
-await I.stopRecordingWebSocketMessages();
-```
-
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/switchTo.mustache

@@ -1,9 +0,0 @@
-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
-```
-
-@param {?CodeceptJS.LocatorOrString} [locator=null] (optional, `null` by default) element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/switchToNextTab.mustache

@@ -1,10 +0,0 @@
-Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
-
-```js
-I.switchToNextTab();
-I.switchToNextTab(2);
-```
-
-@param {number} [num] (optional) number of tabs to switch forward, default: 1.
-@param {number | null} [sec] (optional) time in seconds to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/switchToPreviousTab.mustache

@@ -1,10 +0,0 @@
-Switch focus to a particular tab by its number. It waits tabs loading and then switch tab.
-
-```js
-I.switchToPreviousTab();
-I.switchToPreviousTab(2);
-```
-
-@param {number} [num] (optional) number of tabs to switch backward, default: 1.
-@param {number?} [sec] (optional) time in seconds to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/type.mustache

@@ -1,21 +0,0 @@
-Types out the given text into an active field.
-To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`](#fillfield) is not an option.
-
-```js
-// passing in a string
-I.type('Type this out.');
-
-// typing values with a 100ms interval
-I.type('4141555311111111', 100);
-
-// passing in an array
-I.type(['T', 'E', 'X', 'T']);
-
-// passing a secret
-I.type(secret('123456'));
-```
-
-@param {string|string[]} key or array of keys to type.
-@param {?number} [delay=null] (optional) delay in ms between key presses
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/uncheckOption.mustache

@@ -1,13 +0,0 @@
-Unselects a checkbox or radio button.
-Element is located by label or name or CSS or XPath.
-
-The second parameter is an optional 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');
-```
-@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.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/wait.mustache

@@ -1,8 +0,0 @@
-Pauses execution for a number of seconds.
-
-```js
-I.wait(2); // wait 2 secs
-```
-
-@param {number} sec number of second to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForClickable.mustache

@@ -1,11 +0,0 @@
-Waits for element to be clickable (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitForClickable('.btn.continue');
-I.waitForClickable('.btn.continue', 5); // wait for 5 secs
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForCookie.mustache

@@ -1,9 +0,0 @@
-Waits for the specified cookie in the cookies.
-
-```js
-I.waitForCookie("token");
-```
-
-@param {string} name expected cookie name.
-@param {number} [sec=3] (optional, `3` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForDetached.mustache

@@ -1,10 +0,0 @@
-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 {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForDisabled.mustache

@@ -1,6 +0,0 @@
-Waits for element to become disabled (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForElement.mustache

@@ -1,11 +0,0 @@
-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
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForEnabled.mustache

@@ -1,6 +0,0 @@
-Waits for element to become enabled (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional) time in seconds to wait, 1 by default.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForFunction.mustache

@@ -1,17 +0,0 @@
-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
-```
-
-@param {string|function} fn to be executed in browser context.
-@param {any[]|number} [argsOrSec] (optional, `1` by default) arguments for function or seconds.
-@param {number} [sec] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForInvisible.mustache

@@ -1,10 +0,0 @@
-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 {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForNumberOfTabs.mustache

@@ -1,9 +0,0 @@
-Waits for number of tabs.
-
-```js
-I.waitForNumberOfTabs(2);
-```
-
-@param {number} expectedTabs expecting the number of tabs.
-@param {number} sec number of secs to wait.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForText.mustache

@@ -1,13 +0,0 @@
-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');
-```
-
-@param {string }text to wait for.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@param {CodeceptJS.LocatorOrString} [context] (optional) element located by CSS|XPath|strict locator.
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForValue.mustache

@@ -1,10 +0,0 @@
-Waits for the specified value to be in value attribute.
-
-```js
-I.waitForValue('//input', "GoodValue");
-```
-
-@param {LocatorOrString} field input field.
-@param {string }value expected value.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitForVisible.mustache

@@ -1,10 +0,0 @@
-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 {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitInUrl.mustache

@@ -1,9 +0,0 @@
-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);
-```
-
-@param {string} urlPart value to check.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitNumberOfVisibleElements.mustache

@@ -1,10 +0,0 @@
-Waits for a specified number of elements on the page.
-
-```js
-I.waitNumberOfVisibleElements('a', 3);
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} num number of elements.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitToHide.mustache

@@ -1,10 +0,0 @@
-Waits for an element to hide (by default waits for 1sec).
-Element can be located by CSS or XPath.
-
-```js
-I.waitToHide('#popup');
-```
-
-@param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder

package/docs/webapi/waitUrlEquals.mustache

@@ -1,10 +0,0 @@
-Waits for the entire URL to match the expected
-
-```js
-I.waitUrlEquals('/info', 2);
-I.waitUrlEquals('http://127.0.0.1:8000/info');
-```
-
-@param {string} urlPart value to check.
-@param {number} [sec=1] (optional, `1` by default) time in seconds to wait
-@returns {void} automatically synchronized promise through #recorder