Skip to content

Commit 8b721ca

Browse files
authored
fix: ensure mustache docs include @returns Promise<void> where appropriate (#3954)
1 parent f598059 commit 8b721ca

File tree

92 files changed

+371
-373
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+371
-373
lines changed

docs/webapi/amOnPage.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ I.amOnPage('/login'); // opens a login page
88
```
99

1010
@param {string} url url path or global url.
11-
@return {void} automatically synchronized promise with recorder #!
11+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/appendField.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ I.appendField('password', secret('123456'));
88
```
99
@param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator
1010
@param {string} value text value to append.
11-
⚠️ returns a _promise_ which is synchronized internally by recorder
11+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/attachFile.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
99

1010
@param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
1111
@param {string} pathToFile local file path relative to codecept.conf.ts or codecept.conf.js config file.
12-
⚠️ returns a _promise_ which is synchronized internally by recorder
12+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/blur.mustache

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ I.dontSee('#add-to-cart-btn');
1515

1616
@param {CodeceptJS.LocatorOrString} locator field located by label|name|CSS|XPath|strict locator.
1717
@param {any} [options] Playwright only: [Additional options](https://playwright.dev/docs/api/class-locator#locator-blur) for available options object as 2nd argument.
18+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/checkOption.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ I.checkOption('agree', '//form');
1010
```
1111
@param {CodeceptJS.LocatorOrString} field checkbox located by label | name | CSS | XPath | strict locator.
1212
@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element located by CSS | XPath | strict locator.
13-
⚠️ returns a _promise_ which is synchronized internally by recorder
13+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/clearCookie.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ I.clearCookie('test');
77
```
88

99
@param {?string} [cookie=null] (optional, `null` by default) cookie name
10-
⚠️ returns a _promise_ which is synchronized internally by recorder
10+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/clearField.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ I.clearField('user[email]');
66
I.clearField('#email');
77
```
88
@param {LocatorOrString} editable field located by label|name|CSS|XPath|strict locator.
9-
⚠️ returns a _promise_ which is synchronized internally by recorder.
9+
@returns {Promise<void>} automatically synchronized promise through #recorder.

docs/webapi/click.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ I.click({css: 'nav a.login'});
2222

2323
@param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator.
2424
@param {?CodeceptJS.LocatorOrString | null} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator.
25-
⚠️ returns a _promise_ which is synchronized internally by recorder
25+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/clickLink.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ I.clickLink('Logout', '#nav');
55
```
66
@param {CodeceptJS.LocatorOrString} locator clickable link or button located by text, or any element located by CSS|XPath|strict locator
77
@param {?CodeceptJS.LocatorOrString} [context=null] (optional, `null` by default) element to search in CSS|XPath|Strict locator
8-
⚠️ returns a _promise_ which is synchronized internally by recorder
8+
@returns {Promise<void>} automatically synchronized promise through #recorder

docs/webapi/closeCurrentTab.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ Close current tab.
44
I.closeCurrentTab();
55
```
66

7-
⚠️ returns a _promise_ which is synchronized internally by recorder
7+
@returns {Promise<void>} automatically synchronized promise through #recorder

0 commit comments

Comments
 (0)