diff --git a/docs/helpers/Appium.md b/docs/helpers/Appium.md index 54a1981e2..20025b8c9 100644 --- a/docs/helpers/Appium.md +++ b/docs/helpers/Appium.md @@ -889,7 +889,7 @@ I.appendField('password', secret('123456')); - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator - `value` **[string][5]** text value to append. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### checkOption @@ -909,7 +909,7 @@ I.checkOption('agree', '//form'); - `field` **([string][5] \| [object][11])** checkbox located by label | name | CSS | XPath | strict locator. - `context` **([string][5]? | [object][11])** (optional, `null` by default) element located by CSS | XPath | strict locator. (optional, default `null`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### click @@ -940,7 +940,7 @@ I.click({css: 'nav a.login'}); - `locator` **([string][5] \| [object][11])** clickable link or button located by text, or any element located by CSS|XPath|strict locator. - `context` **([string][5]? | [object][11] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. (optional, default `null`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeCheckboxIsChecked @@ -956,7 +956,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeElement @@ -970,7 +970,7 @@ I.dontSeeElement('.modal'); // modal is not shown - `locator` **([string][5] \| [object][11])** located by CSS|XPath|Strict locator. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeInField @@ -987,7 +987,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator. - `value` **([string][5] \| [object][11])** value to check. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSee @@ -1004,7 +1004,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element - `text` **[string][5]** which is not present. - `context` **([string][5] \| [object][11])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. (optional, default `null`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### fillField @@ -1027,7 +1027,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John'); - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator. - `value` **([string][5] \| [object][11])** text value to fill. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### grabTextFromAll @@ -1173,7 +1173,7 @@ I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "cent - `locator` **([string][5] \| [object][11])** located by CSS|XPath|strict locator. - `scrollIntoViewOptions` **ScrollIntoViewOptions** see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][17]. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorderSupported only for web testing +Returns **void** automatically synchronized promise through #recorderSupported only for web testing ### seeCheckboxIsChecked @@ -1189,7 +1189,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'}); - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### seeElement @@ -1204,7 +1204,7 @@ I.seeElement('#modal'); - `locator` **([string][5] \| [object][11])** located by CSS|XPath|strict locator. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### seeInField @@ -1223,7 +1223,7 @@ I.seeInField('#searchform input','Search'); - `field` **([string][5] \| [object][11])** located by label|name|CSS|XPath|strict locator. - `value` **([string][5] \| [object][11])** value to check. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### see @@ -1241,7 +1241,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator - `text` **[string][5]** expected on page. - `context` **([string][5]? | [object][11])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. (optional, default `null`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### selectOption @@ -1269,7 +1269,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']); - `select` **([string][5] \| [object][11])** field located by label|name|CSS|XPath|strict locator. - `option` **([string][5] \| [Array][8]<any>)** visible text or value of option. -Returns **[Promise][6]<void>** automatically synchronized promise through #recorderSupported only for web testing +Returns **void** automatically synchronized promise through #recorderSupported only for web testing ### waitForElement @@ -1286,7 +1286,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs - `locator` **([string][5] \| [object][11])** element located by CSS|XPath|strict locator. - `sec` **[number][10]?** (optional, `1` by default) time in seconds to wait (optional, default `null`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### waitForVisible @@ -1302,7 +1302,7 @@ I.waitForVisible('#popup'); - `locator` **([string][5] \| [object][11])** element located by CSS|XPath|strict locator. - `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### waitForInvisible @@ -1318,7 +1318,7 @@ I.waitForInvisible('#popup'); - `locator` **([string][5] \| [object][11])** element located by CSS|XPath|strict locator. - `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### waitForText @@ -1337,7 +1337,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal'); - `sec` **[number][10]** (optional, `1` by default) time in seconds to wait (optional, default `1`) - `context` **([string][5] \| [object][11])?** (optional) element located by CSS|XPath|strict locator. (optional, default `null`) -Returns **[Promise][6]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder [1]: http://codecept.io/helpers/WebDriver/ diff --git a/docs/helpers/Nightmare.md b/docs/helpers/Nightmare.md index a9aa49c6c..0a6e8a3d0 100644 --- a/docs/helpers/Nightmare.md +++ b/docs/helpers/Nightmare.md @@ -82,7 +82,7 @@ I.amOnPage('/login'); // opens a login page - `url` **[string][3]** url path or global url. - `headers` **[object][4]?** list of request headers can be passed -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### appendField @@ -100,7 +100,7 @@ I.appendField('password', secret('123456')); - `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator - `value` **[string][3]** text value to append. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### attachFile @@ -118,7 +118,7 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg'); - `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator. - `pathToFile` **[string][3]** local file path relative to codecept.conf.ts or codecept.conf.js config file. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorderDoesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][6]) +Returns **void** automatically synchronized promise through #recorderDoesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][5]) ### checkOption @@ -138,7 +138,7 @@ I.checkOption('agree', '//form'); - `field` **([string][3] | [object][4])** checkbox located by label | name | CSS | XPath | strict locator. - `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS | XPath | strict locator. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### clearCookie @@ -169,7 +169,7 @@ I.clearField('#email'); - `field` - `editable` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder. +Returns **void** automatically synchronized promise through #recorder. ### click @@ -200,7 +200,7 @@ I.click({css: 'nav a.login'}); - `locator` **([string][3] | [object][4])** clickable link or button located by text, or any element located by CSS|XPath|strict locator. - `context` **([string][3]? | [object][4] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSee @@ -217,7 +217,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element - `text` **[string][3]** which is not present. - `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeCheckboxIsChecked @@ -233,7 +233,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name - `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeCookie @@ -247,7 +247,7 @@ I.dontSeeCookie('auth'); // no auth cookie - `name` **[string][3]** cookie name. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeCurrentUrlEquals @@ -263,7 +263,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also - `url` **[string][3]** value to check. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeElement @@ -277,7 +277,7 @@ I.dontSeeElement('.modal'); // modal is not shown - `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeElementInDOM @@ -291,7 +291,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or - `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeInCurrentUrl @@ -301,7 +301,7 @@ Checks that current url does not contain a provided fragment. - `url` **[string][3]** value to check. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeInField @@ -318,7 +318,7 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS - `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator. - `value` **([string][3] | [object][4])** value to check. -Returns **[Promise][5]<void>** automatically synchronized promise through #recorder +Returns **void** automatically synchronized promise through #recorder ### dontSeeInSource @@ -333,7 +333,7 @@ I.dontSeeInSource('