Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ensure docs include @returns Promise<void> where appropriate #3954

Merged
merged 1 commit into from
Oct 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/webapi/amOnPage.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/appendField.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/attachFile.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/webapi/blur.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/checkOption.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/clearCookie.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/clearField.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/webapi/click.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/clickLink.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/closeCurrentTab.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/closeOtherTabs.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSee.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeCheckboxIsChecked.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeCookie.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeCurrentUrlEquals.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeElement.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeElementInDOM.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeInCurrentUrl.mustache
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeInField.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ I.dontSeeInField({ css: 'form input.email' }, '[email protected]'); // 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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeInSource.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dontSeeInTitle.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/doubleClick.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/downloadFile.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dragAndDrop.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/dragSlider.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 0 additions & 2 deletions docs/webapi/executeAsyncScript.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 0 additions & 2 deletions docs/webapi/executeScript.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/fillField.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/webapi/focus.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/forceClick.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/forceRightClick.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/grabDataFromPerformanceTiming.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/moveCursorTo.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/openNewTab.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/pressKey.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/pressKeyDown.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/pressKeyUp.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/pressKeyWithKeyNormalization.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/refreshPage.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/resizeWindow.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/rightClick.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/saveElementScreenshot.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/saveScreenshot.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/say.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/scrollIntoView.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/scrollPageToBottom.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/scrollPageToTop.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/scrollTo.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/see.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeAttributesOnElements.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeCheckboxIsChecked.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeCookie.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeCssPropertiesOnElements.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeCurrentUrlEquals.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeElement.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeElementInDOM.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeInCurrentUrl.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeInField.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/webapi/seeInPopup.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ given string.
I.seeInPopup('Popup text');
```
@param {string} text value to check.
⚠️ returns a _promise_ which is synchronized internally by recorder
@returns {Promise<void>} automatically synchronized promise through #recorder
2 changes: 1 addition & 1 deletion docs/webapi/seeInSource.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Checks that the current page contains the given string in its raw source code.
I.seeInSource('<h1>Green eggs &amp; ham</h1>');
```
@param {string} text value to check.
⚠️ returns a _promise_ which is synchronized internally by recorder
@returns {Promise<void>} automatically synchronized promise through #recorder
2 changes: 1 addition & 1 deletion docs/webapi/seeInTitle.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ I.seeInTitle('Home Page');
```

@param {string} text text value to check.
⚠️ returns a _promise_ which is synchronized internally by recorder
@returns {Promise<void>} automatically synchronized promise through #recorder
Loading