codeceptjs 3.5.5 → 3.5.7-beta.1

package/docs/mobile.md

@@ -24,13 +24,13 @@ I.seeElement({
 });
 ```
 
-This test is easy to read and write. Also it will work both on iOS and Android devices.
+This test is easy to read and write. Also, it will work both on iOS and Android devices.
 Doesn't it sound cool?
 
 ## Setting Up
 
 Ensure that you have [CodeceptJS installed](https://codecept.io/installation/).
-You will also need to install [Appium](https://appium.io/).
+You will also need to install [Appium](https://appium.io/docs/en/2.1/).
 We suggest to use [appium-doctor](https://www.npmjs.com/package/appium-doctor) to check if your system is ready for mobile testing.
 
 ```sh
@@ -45,13 +45,12 @@ To install Appium use npm:
 npm i -g appium
 ```
 
-To use Appium 2.x:
-```sh
-npm i -g appium@next
-```
-Appium 2x (still beta) reenvisions Appium as a platform where “drivers” and “plugins” can be easily created and shared independently.
+Appium 2x reenvisions Appium as a platform where “drivers” and “plugins” can be easily created and shared independently.
+
+** Note: ** Appium v1 is no longer maintained, so it's advised to migrate to Appium v2.
+
 Install an Appium driver and its dependencies
-To install the Appium driver and its dependencies, we'll be using the uiautomator2 (Android), XCUITest (iOS) drivers.
+To install the Appium driver and its dependencies, we'll be using the `uiautomator2` (Android), `XCUITest` (iOS) drivers.
 
 ```
 appium driver install xcuitest
@@ -79,11 +78,6 @@ It should be packed into apk (for Android) or .ipa (for iOS) or zip.
 Next, is to launch the emulator or connect a physical device.
 Once they are prepared, launch Appium:
 
-```sh
-appium
-```
-
-To use Appium 2.x:
 ```sh
 tth~$npx appium --base-path=/wd/hub
 [Appium] Welcome to Appium v2.0.0-beta.57 (REV 3e675c32ae71dc0b00749d5d29213e2ea5b53c5b)
@@ -102,7 +96,9 @@ tth~$npx appium --base-path=/wd/hub
 [Appium] No plugins have been installed. Use the "appium plugin" command to install the one(s) you want to use.
 ```
 
-To run mobile test you need either an device emulator (available with Android SDK or iOS), real device connected for mobile testing. Alternatively, you may execute Appium with device emulator inside Docker container.
+** Note: ** Appium v2 doesn't use the same base path as Appium v1, hence if you want to use the same base path you should pass `--base-path=/wd/hub` when launching the Appium server.
+
+To run mobile test you need either a device emulator (available with Android SDK or iOS) or real device connected for mobile testing. Alternatively, you may execute Appium with device emulator inside Docker container.
 
 CodeceptJS should be installed with webdriverio support:
 
@@ -135,7 +131,7 @@ You will also be asked for the platform and the application package.
 ```
 
 Check the newly created `codecept.conf.js` configuration file.
-You may want to set some additional Appium settings via [desiredCapabilities](https://appium.io/docs/en/writing-running-appium/caps/)
+You may want to set some additional Appium settings via [desiredCapabilities](https://appium.io/docs/en/2.1/guides/caps/)
 
 ```js
 helpers: {
@@ -147,7 +143,7 @@ helpers: {
 }
 ```
 
-Once you configured Appium, create the first test by running
+Once you configured Appium, create the first test by running:
 
 ```sh
 npx codeceptjs gt
@@ -219,7 +215,7 @@ To start writing a test it is important to understand how to locate elements for
 In both Android and iPhone elements are defined in XML format and can be searched by XPath locators.
 
 ```js
-I.seeElement('//android.widget.ScrollView/android.widget.LinearLayout')'
+I.seeElement('//android.widget.ScrollView/android.widget.LinearLayout')
 ```
 
 > Despite showing XPath in this guide we **do not recommend using XPath for testing iOS native apps. XPath runs very slow on iOS. Consider using ID or Accessibility ID locators instead.
@@ -243,7 +239,7 @@ I.seeElement('~startUserRegistrationButton');
 ```
 
 Elements can also have ids, which can be located with `#` prefix.
-On Android it it is important to keep full package name in id locator:
+On Android, it is important to keep full package name in id locator:
 
 ```js
 I.seeElement('#io.selendroid.testapp:id/inputUsername');
@@ -258,9 +254,9 @@ I.click('Click me!');
 
 Native iOS/Android locators can be used with `android=` and `ios=` prefixes. [Learn more](https://webdriver.io/guide/usage/selectors.html#Mobile-Selectors).
 
-But how to get all those locators? We recommend to use [Appium Inspector](https://github.com/appium/appium-desktop).
+But how to get all those locators? We recommend to use [Appium Inspector](https://github.com/appium/appium-inspector).
 
-For Android you can use **UI Automator Viewer** bundled with Android SDK:
+For Android, you can use **UI Automator Viewer** bundled with Android SDK:
 
 ![](https://user-images.githubusercontent.com/220264/27566310-1f631604-5aed-11e7-8b92-1ffe9e9f14f9.png)
 
@@ -284,7 +280,7 @@ Inside WebView all browser features are enabled: CSS locators, JavaScript, etc.
 To set a specific context use `{ web: 'webview.context' }` instead:
 
 ```js
-within({webview: 'MyWEBVIEW_com.my.app'}, () => );
+within({webview: 'MyWEBVIEW_com.my.app'}, () => {});
 ```
 
 Alternatively use `switchToWeb` or `switchToNative` methods to switch between contexts.

package/docs/plugins.md

@@ -89,7 +89,7 @@ Scenario('log me in', ( {I, login} ) => {
 #### How It Works
 
 1.  `restore` method is executed. It should open a page and set credentials.
-2.  `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged in user.
+2.  `check` method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged-in user. When you pass the second args `session`, you could perform the validation using passed session.
 3.  If `restore` and `check` were not successful, `login` is executed
 4.  `login` should fill in login form
 5.  After successful login, `fetch` is executed to save cookies into memory or file.
@@ -240,6 +240,40 @@ Scenario('login', async ( {I, login} ) => {
 })
 ```
 
+#### Tips: Using session to validate user
+
+Instead of asserting on page elements for the current user in `check`, you can use the `session` you saved in `fetch`
+
+```js
+autoLogin: {
+  enabled: true,
+  saveToFile: true,
+  inject: 'login',
+  users: {
+    admin: {
+      login: async (I) => {  // If you use async function in the autoLogin plugin
+         const phrase = await I.grabTextFrom('#phrase')
+         I.fillField('username', 'admin'),
+         I.fillField('password', 'password')
+         I.fillField('phrase', phrase)
+      },
+      check: (I, session) => {
+         // Throwing an error in `check` will make CodeceptJS perform the login step for the user
+         if (session.profile.email !== the.email.you.expect@some-mail.com) {
+              throw new Error ('Wrong user signed in');
+        }
+      },
+    }
+  }
+}
+```
+
+```js
+Scenario('login', async ( {I, login} ) => {
+  await login('admin') // you should use `await`
+})
+```
+
 ### Parameters
 
 -   `config`  

package/docs/webapi/amOnPage.mustache

@@ -8,4 +8,4 @@ I.amOnPage('/login'); // opens a login page
 ```
 
 @param {string} url url path or global url.
-@return {void} automatically synchronized promise with recorder #! 
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/appendField.mustache

@@ -8,4 +8,4 @@ I.appendField('password', secret('123456'));
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
 @param {string} value text value to append.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/attachFile.mustache

@@ -9,4 +9,4 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
 @param {string} pathToFile local file path relative to codecept.conf.ts or codecept.conf.js config file.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/blur.mustache

@@ -15,3 +15,4 @@ I.dontSee('#add-to-cart-btn');
 
 @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
 @param {any} [options] Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/checkOption.mustache

@@ -10,4 +10,4 @@ I.checkOption('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 a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/clearCookie.mustache

@@ -7,4 +7,4 @@ I.clearCookie('test');
 ```
 
 @param {?string} [cookie=null] (optional, `null` by default) cookie name
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/clearField.mustache

@@ -6,4 +6,4 @@ I.clearField('user[email]');
 I.clearField('#email');
 ```
 @param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder.
+@returns {Promise<void>} automatically synchronized promise through #recorder.

package/docs/webapi/click.mustache

@@ -22,4 +22,4 @@ I.click({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 | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/clickLink.mustache

@@ -5,4 +5,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/closeCurrentTab.mustache

@@ -4,4 +4,4 @@ Close current tab.
 I.closeCurrentTab();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/closeOtherTabs.mustache

@@ -5,4 +5,4 @@ Close all tabs except for the current one.
 I.closeOtherTabs();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSee.mustache

@@ -8,4 +8,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeCheckboxIsChecked.mustache

@@ -7,4 +7,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeCookie.mustache

@@ -5,4 +5,4 @@ I.dontSeeCookie('auth'); // no auth cookie
 ```
 
 @param {string} name cookie name.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeCurrentUrlEquals.mustache

@@ -7,4 +7,4 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 ```
 
 @param {string} url value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeElement.mustache

@@ -5,4 +5,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeElementInDOM.mustache

@@ -5,4 +5,4 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 ```
 
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|Strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeInCurrentUrl.mustache

@@ -1,4 +1,4 @@
 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeInField.mustache

@@ -8,4 +8,4 @@ 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 {CodeceptJS.StringOrSecret} value value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeInSource.mustache

@@ -5,4 +5,4 @@ I.dontSeeInSource('<!--'); // no comments in source
 ```
 
 @param {string} value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dontSeeInTitle.mustache

@@ -5,4 +5,4 @@ I.dontSeeInTitle('Error');
 ```
 
 @param {string} text value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/doubleClick.mustache

@@ -10,4 +10,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/downloadFile.mustache

@@ -9,4 +9,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dragAndDrop.mustache

@@ -6,4 +6,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/dragSlider.mustache

@@ -8,4 +8,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/executeAsyncScript.mustache

@@ -22,5 +22,3 @@ let val = await I.executeAsyncScript(function(url, done) {
 @param {string|function} fn function to be executed in browser context.
 @param {...any} args to be passed to function.
 @returns {Promise<any>} script return value
-
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/executeScript.mustache

@@ -24,5 +24,3 @@ let date = await I.executeScript(function(el) {
 @param {string|function} fn function to be executed in browser context.
 @param {...any} args to be passed to function.
 @returns {Promise<any>} script return value
-
-⚠️ returns a _promise_ which is synchronized internally by recorder

package/docs/webapi/fillField.mustache

@@ -13,4 +13,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/focus.mustache

@@ -10,3 +10,4 @@ I.see('#add-to-cart-bnt');
 
 @param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
 @param {any} [options] Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-focus) for available options object as 2nd argument.
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/forceClick.mustache

@@ -25,4 +25,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/forceRightClick.mustache

@@ -15,4 +15,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/grabCookie.mustache

@@ -8,4 +8,4 @@ assert(cookie.value, '123456');
 ```
 
 @param {?string} [name=null] cookie name.
-@returns {Promise<string>|Promise<string[]>} attribute value
+@returns {any} attribute value

package/docs/webapi/grabDataFromPerformanceTiming.mustache

@@ -17,4 +17,4 @@ let data = await I.grabDataFromPerformanceTiming();
   loadEventEnd: 241
 }
 ```
-@return {Promise<any>} automatically synchronized promise through #recorder 
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/moveCursorTo.mustache

@@ -9,4 +9,4 @@ 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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/openNewTab.mustache

@@ -4,4 +4,4 @@ Open new tab and switch to it.
 I.openNewTab();
 ```
 
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/pressKey.mustache

@@ -9,4 +9,4 @@ I.pressKey(['Control','a']);
 ```
 
 @param {string|string[]} key key or array of keys to press.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/pressKeyDown.mustache

@@ -9,4 +9,4 @@ I.pressKeyUp('Control');
 ```
 
 @param {string} key name of key to press down.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/pressKeyUp.mustache

@@ -9,4 +9,4 @@ I.pressKeyUp('Control');
 ```
 
 @param {string} key name of key to release.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/pressKeyWithKeyNormalization.mustache

@@ -57,4 +57,4 @@ Some of the supported key names are:
 - `'Tab'`
 
 @param {string|string[]} key key or array of keys to press.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/refreshPage.mustache

@@ -3,4 +3,4 @@ Reload the current page.
 ```js
 I.refreshPage();
 ```
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/resizeWindow.mustache

@@ -3,4 +3,4 @@ First parameter can be set to `maximize`.
 
 @param {number} width width in pixels or `maximize`.
 @param {number} height height in pixels.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/rightClick.mustache

@@ -11,4 +11,4 @@ I.rightClick('Click me', '.context');
 
 @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.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/saveElementScreenshot.mustache

@@ -7,4 +7,4 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
 @param {string} fileName file name to save.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/saveScreenshot.mustache

@@ -9,4 +9,4 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 @param {string} fileName file name to save.
 @param {boolean} [fullPage=false] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/say.mustache

@@ -7,4 +7,4 @@ I.say('This is by default'); //cyan is used
 ```
 @param {string} text expected on console log.
 @param {string} [color='cyan'] color you want to use.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/scrollIntoView.mustache

@@ -8,4 +8,4 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent
 
 @param {LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {ScrollIntoViewOptions} scrollIntoViewOptions see https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/scrollPageToBottom.mustache

@@ -3,4 +3,4 @@ Scroll page to the bottom.
 ```js
 I.scrollPageToBottom();
 ```
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/scrollPageToTop.mustache

@@ -3,4 +3,4 @@ Scroll page to the top.
 ```js
 I.scrollPageToTop();
 ```
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/scrollTo.mustache

@@ -9,4 +9,4 @@ I.scrollTo('#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
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/see.mustache

@@ -8,4 +8,4 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 ```
 @param {string} text expected on page.
 @param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeAttributesOnElements.mustache

@@ -6,4 +6,4 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {object} attributes attributes and their values to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeCheckboxIsChecked.mustache

@@ -7,4 +7,4 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 ```
 
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeCookie.mustache

@@ -5,4 +5,4 @@ I.seeCookie('Auth');
 ```
 
 @param {string} name cookie name.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeCssPropertiesOnElements.mustache

@@ -6,4 +6,4 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
 @param {object} cssProperties object with CSS properties and their values to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeCurrentUrlEquals.mustache

@@ -8,4 +8,4 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 ```
 
 @param {string} url value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeElement.mustache

@@ -5,4 +5,4 @@ Element is located by CSS or XPath.
 I.seeElement('#modal');
 ```
 @param {CodeceptJS.LocatorOrString} locator located by CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeElementInDOM.mustache

@@ -5,4 +5,4 @@ Element is located by CSS or XPath.
 I.seeElementInDOM('#modal');
 ```
 @param {CodeceptJS.LocatorOrString} locator element located by CSS|XPath|strict locator.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeInCurrentUrl.mustache

@@ -5,4 +5,4 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 ```
 
 @param {string} url a fragment to check
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder

package/docs/webapi/seeInField.mustache

@@ -9,4 +9,4 @@ I.seeInField('#searchform input','Search');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
 @param {CodeceptJS.StringOrSecret} value value to check.
-⚠️ returns a _promise_ which is synchronized internally by recorder
+@returns {Promise<void>} automatically synchronized promise through #recorder