codeceptjs 3.3.0-beta.4 → 3.3.1

package/docs/helpers/GraphQLDataFactory.md

@@ -43,7 +43,7 @@ To make this work you need
 Install [Rosie][1] and [Faker][2] libraries.
 
 ```sh
-npm i rosie faker --save-dev
+npm i rosie @faker-js/faker --save-dev
 ```
 
 Create a factory file for a resource.
@@ -53,8 +53,8 @@ See the example for Users factories:
 ```js
 // tests/factories/users.js
 
-var Factory = require('rosie').Factory;
-var faker = require('faker');
+const Factory = require('rosie').Factory;
+const faker = require('@faker-js/faker');
 
 // Used with a constructor function passed to Factory, so that the final build
 // object matches the necessary pattern to be sent as the variables object.

package/docs/helpers/JSONResponse.md

@@ -207,7 +207,7 @@ Executes a callback function passing in `response` object and chai assertions wi
 Use it to perform custom checks of response data
 
 ```js
-I.seeResponseValidByCallback({ data, status, expect } => {
+I.seeResponseValidByCallback(({ data, status, expect }) => {
   expect(status).to.eql(200);
   expect(data).keys.to.include(['user', 'company']);
 });

package/docs/helpers/MockRequest.md

@@ -244,13 +244,15 @@ I.mockRequest('GET', ['/secrets', '/v2/secrets'], 403);
 Use PollyJS [Server Routes API][12] to declare mocks via callback function:
 
 ```js
-// basic usage
-server.get('/api/v2/users').intercept((req, res) => {
-  res.sendStatus(200).json({ users });
-});
+I.mockServer((server) => {
+  // basic usage
+  server.get('/api/v2/users').intercept((req, res) => {
+    res.sendStatus(200).json({ users });
+  });
 
-// passthrough requests to "/api/v2"
-server.get('/api/v1').passthrough();
+  // passthrough requests to "/api/v2"
+  server.get('/api/v1').passthrough();
+});
 ```
 
 In record replay mode you can define which routes should be recorded and where to store them:

package/docs/helpers/Nightmare.md

@@ -82,6 +82,8 @@ 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]<any>** 
+
 ### appendField
 
 Appends text to a input field or textarea.
@@ -96,6 +98,8 @@ I.appendField('#myTextField', 'appended');
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator
 -   `value` **[string][3]** text value to append.
 
+Returns **[Promise][5]<any>** 
+
 ### attachFile
 
 Attaches a file to element located by label, name, CSS or XPath
@@ -110,7 +114,9 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 #### Parameters
 
 -   `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
--   `pathToFile` **[string][3]** local file path relative to codecept.json config file.Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][5])
+-   `pathToFile` **[string][3]** local file path relative to codecept.json config file.
+
+Returns **[Promise][5]<any>** Doesn't work if the Chromium DevTools panel is open (as Chromium allows only one attachment to the debugger at a time. [See more][6])
 
 ### checkOption
 
@@ -130,6 +136,8 @@ 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]<any>** 
+
 ### clearCookie
 
 Clears a cookie by name,
@@ -144,6 +152,8 @@ I.clearCookie('test');
 
 -   `cookie` **[string][3]?** (optional, `null` by default) cookie name 
 
+Returns **[Promise][5]<any>** 
+
 ### clearField
 
 Clears a `<textarea>` or text `<input>` element's value.
@@ -159,6 +169,8 @@ I.clearField('#email');
 -   `field`  
 -   `editable` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### click
 
 Perform a click on a link or a button, given by a locator.
@@ -186,7 +198,9 @@ I.click({css: 'nav a.login'});
 #### Parameters
 
 -   `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])** (optional, `null` by default) element to search in 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]&lt;any>** 
 
 ### dontSee
 
@@ -203,6 +217,8 @@ 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]&lt;any>** 
+
 ### dontSeeCheckboxIsChecked
 
 Verifies that the specified checkbox is not checked.
@@ -217,6 +233,8 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeCookie
 
 Checks that cookie with given name does not exist.
@@ -229,6 +247,8 @@ I.dontSeeCookie('auth'); // no auth cookie
 
 -   `name` **[string][3]** cookie name.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeCurrentUrlEquals
 
 Checks that current url is not equal to provided one.
@@ -243,6 +263,8 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 
 -   `url` **[string][3]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeElement
 
 Opposite to `seeElement`. Checks that element is not visible (or in DOM)
@@ -255,6 +277,8 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 -   `locator` **([string][3] | [object][4])** located by CSS|XPath|Strict locator.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeElementInDOM
 
 Opposite to `seeElementInDOM`. Checks that element is not on page.
@@ -267,6 +291,8 @@ 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]&lt;any>** 
+
 ### dontSeeInCurrentUrl
 
 Checks that current url does not contain a provided fragment.
@@ -275,6 +301,8 @@ Checks that current url does not contain a provided fragment.
 
 -   `url` **[string][3]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeInField
 
 Checks that value of input field or textarea doesn't equal to given value
@@ -290,6 +318,8 @@ 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]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeInSource
 
 Checks that the current page does not contains the given string in its raw source code.
@@ -303,6 +333,8 @@ I.dontSeeInSource('<!--'); // no comments in source
 -   `text`  
 -   `value` **[string][3]** to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### dontSeeInTitle
 
 Checks that title does not contain text.
@@ -315,6 +347,8 @@ I.dontSeeInTitle('Error');
 
 -   `text` **[string][3]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### doubleClick
 
 Performs a double-click on an element matched by link|button|label|CSS or XPath.
@@ -332,12 +366,14 @@ I.doubleClick('.btn.edit');
 -   `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])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### executeAsyncScript
 
 Executes async script on page.
 Provided function should execute a passed callback (as first argument) to signal it is finished.
 
-Example: In Vue.js to make components completely rendered we are waiting for [nextTick][6].
+Example: In Vue.js to make components completely rendered we are waiting for [nextTick][7].
 
 ```js
 I.executeAsyncScript(function(done) {
@@ -358,9 +394,9 @@ let val = await I.executeAsyncScript(function(url, done) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
--   `fn` **([string][3] | [function][7])** function to be executed in browser context.
+-   `fn` **([string][3] | [function][8])** function to be executed in browser context.
 
-Returns **[Promise][8]&lt;any>** Wrapper for asynchronous [evaluate][9].
+Returns **[Promise][5]&lt;any>** Wrapper for asynchronous [evaluate][9].
 Unlike NightmareJS implementation calling `done` will return its first argument.
 
 ### executeScript
@@ -392,9 +428,9 @@ let date = await I.executeScript(function(el) {
 #### Parameters
 
 -   `args` **...any** to be passed to function.
--   `fn` **([string][3] | [function][7])** function to be executed in browser context.
+-   `fn` **([string][3] | [function][8])** function to be executed in browser context.
 
-Returns **[Promise][8]&lt;any>** Wrapper for synchronous [evaluate][9]
+Returns **[Promise][5]&lt;any>** Wrapper for synchronous [evaluate][9]
 
 ### fillField
 
@@ -417,6 +453,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **([string][3] | [object][4])** text value to fill.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### grabAttributeFrom
 
 Retrieves an attribute from an element located by CSS or XPath and returns it to test.
@@ -432,7 +470,7 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][3]** attribute name.
 
-Returns **[Promise][8]&lt;[string][3]>** attribute value
+Returns **[Promise][5]&lt;[string][3]>** attribute value
 
 ### grabAttributeFromAll
 
@@ -448,7 +486,7 @@ let hints = await I.grabAttributeFromAll('.tooltip', 'title');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `attr` **[string][3]** attribute name.
 
-Returns **[Promise][8]&lt;[Array][10]&lt;[string][3]>>** attribute value
+Returns **[Promise][5]&lt;[Array][10]&lt;[string][3]>>** attribute value
 
 ### grabCookie
 
@@ -465,7 +503,7 @@ assert(cookie.value, '123456');
 
 -   `name` **[string][3]?** cookie name. 
 
-Returns **([Promise][8]&lt;[string][3]> | [Promise][8]&lt;[Array][10]&lt;[string][3]>>)** attribute valueCookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
+Returns **([Promise][5]&lt;[string][3]> | [Promise][5]&lt;[Array][10]&lt;[string][3]>>)** attribute valueCookie in JSON format. If name not passed returns all cookies for this domain.Multiple cookies can be received by passing query object `I.grabCookie({ secure: true});`. If you'd like get all cookies for all urls, use: `.grabCookie({ url: null }).`
 
 ### grabCssPropertyFrom
 
@@ -482,7 +520,7 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `cssProperty` **[string][3]** CSS property name.
 
-Returns **[Promise][8]&lt;[string][3]>** CSS value
+Returns **[Promise][5]&lt;[string][3]>** CSS value
 
 ### grabCurrentUrl
 
@@ -494,7 +532,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns **[Promise][8]&lt;[string][3]>** current URL
+Returns **[Promise][5]&lt;[string][3]>** current URL
 
 ### grabElementBoundingRect
 
@@ -522,7 +560,7 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 -   `prop`  
 -   `elementSize` **[string][3]?** x, y, width or height of the given element.
 
-Returns **([Promise][8]&lt;DOMRect> | [Promise][8]&lt;[number][11]>)** Element bounding rectangle
+Returns **([Promise][5]&lt;DOMRect> | [Promise][5]&lt;[number][11]>)** Element bounding rectangle
 
 ### grabHAR
 
@@ -548,7 +586,7 @@ let postHTML = await I.grabHTMLFrom('#post');
 -   `locator`  
 -   `element` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[string][3]>** HTML code for an element
+Returns **[Promise][5]&lt;[string][3]>** HTML code for an element
 
 ### grabHTMLFromAll
 
@@ -564,7 +602,7 @@ let postHTMLs = await I.grabHTMLFromAll('.post');
 -   `locator`  
 -   `element` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[Array][10]&lt;[string][3]>>** HTML code for an element
+Returns **[Promise][5]&lt;[Array][10]&lt;[string][3]>>** HTML code for an element
 
 ### grabNumberOfVisibleElements
 
@@ -579,7 +617,7 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 -   `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[number][11]>** number of visible elements
+Returns **[Promise][5]&lt;[number][11]>** number of visible elements
 
 ### grabPageScrollPosition
 
@@ -590,7 +628,7 @@ Resumes test execution, so **should be used inside an async function with `await
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns **[Promise][8]&lt;PageScrollPosition>** scroll position
+Returns **[Promise][5]&lt;PageScrollPosition>** scroll position
 
 ### grabTextFrom
 
@@ -607,7 +645,7 @@ If multiple elements found returns first element.
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[string][3]>** attribute value
+Returns **[Promise][5]&lt;[string][3]>** attribute value
 
 ### grabTextFromAll
 
@@ -622,7 +660,7 @@ let pins = await I.grabTextFromAll('#pin li');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[Array][10]&lt;[string][3]>>** attribute value
+Returns **[Promise][5]&lt;[Array][10]&lt;[string][3]>>** attribute value
 
 ### grabTitle
 
@@ -633,7 +671,7 @@ Resumes test execution, so **should be used inside async with `await`** operator
 let title = await I.grabTitle();
 ```
 
-Returns **[Promise][8]&lt;[string][3]>** title
+Returns **[Promise][5]&lt;[string][3]>** title
 
 ### grabValueFrom
 
@@ -649,7 +687,7 @@ let email = await I.grabValueFrom('input[name=email]');
 
 -   `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[string][3]>** attribute value
+Returns **[Promise][5]&lt;[string][3]>** attribute value
 
 ### grabValueFromAll
 
@@ -664,7 +702,7 @@ let inputs = await I.grabValueFromAll('//form/input');
 
 -   `locator` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 
-Returns **[Promise][8]&lt;[Array][10]&lt;[string][3]>>** attribute value
+Returns **[Promise][5]&lt;[Array][10]&lt;[string][3]>>** attribute value
 
 ### haveHeader
 
@@ -696,6 +734,8 @@ I.moveCursorTo('#submit', 5,5);
 -   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### pressKey
 
 Sends [input event][12] on a page.
@@ -717,6 +757,8 @@ Reload the current page.
 I.refreshPage();
 ```
 
+Returns **[Promise][5]&lt;any>** 
+
 ### resizeWindow
 
 Resize the current window to provided width and height.
@@ -727,6 +769,8 @@ First parameter can be set to `maximize`.
 -   `width` **[number][11]** width in pixels or `maximize`.
 -   `height` **[number][11]** height in pixels.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### rightClick
 
 Performs right click on a clickable element matched by semantic locator, CSS or XPath.
@@ -745,6 +789,8 @@ I.rightClick('Click me', '.context');
 -   `locator` **([string][3] | [object][4])** clickable element located by CSS|XPath|strict locator.
 -   `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### saveElementScreenshot
 
 Saves screenshot of the specified locator to ouput folder (set in codecept.json or codecept.conf.js).
@@ -759,6 +805,8 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][3]** file name to save.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### saveScreenshot
 
 Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
@@ -775,6 +823,8 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 -   `fileName` **[string][3]** file name to save.
 -   `fullPage` **[boolean][13]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### scrollPageToBottom
 
 Scroll page to the bottom.
@@ -783,6 +833,8 @@ Scroll page to the bottom.
 I.scrollPageToBottom();
 ```
 
+Returns **[Promise][5]&lt;any>** 
+
 ### scrollPageToTop
 
 Scroll page to the top.
@@ -791,6 +843,8 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
+Returns **[Promise][5]&lt;any>** 
+
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -807,6 +861,8 @@ I.scrollTo('#submit', 5, 5);
 -   `offsetX` **[number][11]** (optional, `0` by default) X-axis offset. 
 -   `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### see
 
 Checks that a page contains a visible text.
@@ -823,6 +879,8 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 -   `text` **[string][3]** expected on page.
 -   `context` **([string][3]? | [object][4])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeCheckboxIsChecked
 
 Verifies that the specified checkbox is checked.
@@ -837,6 +895,8 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeCookie
 
 Checks that cookie with given name exists.
@@ -849,6 +909,8 @@ I.seeCookie('Auth');
 
 -   `name` **[string][3]** cookie name.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeCurrentUrlEquals
 
 Checks that current url is equal to provided one.
@@ -864,6 +926,8 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 -   `url` **[string][3]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeElement
 
 Checks that a given Element is visible
@@ -877,6 +941,8 @@ I.seeElement('#modal');
 
 -   `locator` **([string][3] | [object][4])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeElementInDOM
 
 Checks that a given Element is present in the DOM
@@ -890,6 +956,8 @@ I.seeElementInDOM('#modal');
 
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeInCurrentUrl
 
 Checks that current url contains a provided fragment.
@@ -902,6 +970,8 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 -   `url` **[string][3]** a fragment to check
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeInField
 
 Checks that the given input field or textarea equals to given value.
@@ -919,6 +989,8 @@ I.seeInField('#searchform input','Search');
 -   `field` **([string][3] | [object][4])** located by label|name|CSS|XPath|strict locator.
 -   `value` **[string][3]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeInSource
 
 Checks that the current page contains the given string in its raw source code.
@@ -931,6 +1003,8 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 -   `text` **[string][3]** value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeInTitle
 
 Checks that title contains text.
@@ -943,6 +1017,8 @@ I.seeInTitle('Home Page');
 
 -   `text` **[string][3]** text value to check.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeNumberOfElements
 
 Asserts that an element appears a given number of times in the DOM.
@@ -957,6 +1033,8 @@ I.seeNumberOfElements('#submitBtn', 1);
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][11]** number of elements.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### seeNumberOfVisibleElements
 
 Asserts that an element is visible a given number of times.
@@ -971,6 +1049,8 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `num` **[number][11]** number of elements.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### selectOption
 
 Selects an option in a drop-down select.
@@ -997,6 +1077,8 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 -   `select` **([string][3] | [object][4])** field located by label|name|CSS|XPath|strict locator.
 -   `option` **([string][3] | [Array][10]&lt;any>)** visible text or value of option.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### setCookie
 
 Sets cookie(s).
@@ -1015,8 +1097,10 @@ I.setCookie([
 
 #### Parameters
 
--   `cookie` **(Cookie | [Array][10]&lt;Cookie>)** a cookie object or array of cookie objects.Wrapper for `.cookies.set(cookie)`.
-    [See more][14]
+-   `cookie` **(Cookie | [Array][10]&lt;Cookie>)** a cookie object or array of cookie objects.
+
+Returns **[Promise][5]&lt;any>** Wrapper for `.cookies.set(cookie)`.
+[See more][14]
 
 ### triggerMouseEvent
 
@@ -1051,6 +1135,8 @@ I.uncheckOption('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]&lt;any>** 
+
 ### wait
 
 Pauses execution for a number of seconds.
@@ -1063,6 +1149,8 @@ I.wait(2); // wait 2 secs
 
 -   `sec` **[number][11]** number of second to wait.
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitForDetached
 
 Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
@@ -1077,6 +1165,8 @@ I.waitForDetached('#popup');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitForElement
 
 Waits for element to be present on page (by default waits for 1sec).
@@ -1092,6 +1182,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitForFunction
 
 Waits for a function to return true (waits for 1 sec by default).
@@ -1109,10 +1201,12 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` **([string][3] | [function][7])** to be executed in browser context.
+-   `fn` **([string][3] | [function][8])** to be executed in browser context.
 -   `argsOrSec` **([Array][10]&lt;any> | [number][11])?** (optional, `1` by default) arguments for function or seconds. 
 -   `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitForInvisible
 
 Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
@@ -1127,6 +1221,8 @@ I.waitForInvisible('#popup');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitForText
 
 Waits for a text to appear (by default waits for 1sec).
@@ -1144,6 +1240,8 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 -   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
 -   `context` **([string][3] | [object][4])?** (optional) element located by CSS|XPath|strict locator. 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitForVisible
 
 Waits for an element to become visible on a page (by default waits for 1sec).
@@ -1158,6 +1256,8 @@ I.waitForVisible('#popup');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
 
+Returns **[Promise][5]&lt;any>** 
+
 ### waitToHide
 
 Waits for an element to hide (by default waits for 1sec).
@@ -1172,6 +1272,8 @@ I.waitToHide('#popup');
 -   `locator` **([string][3] | [object][4])** element located by CSS|XPath|strict locator.
 -   `sec` **[number][11]** (optional, `1` by default) time in seconds to wait 
 
+Returns **[Promise][5]&lt;any>** 
+
 [1]: https://github.com/segmentio/nightmare
 
 [2]: https://github.com/segmentio/nightmare#api
@@ -1180,13 +1282,13 @@ I.waitToHide('#popup');
 
 [4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[5]: https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[6]: https://vuejs.org/v2/api/#Vue-nextTick
+[6]: https://github.com/rosshinkley/nightmare-upload#important-note-about-setting-file-upload-inputs
 
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+[7]: https://vuejs.org/v2/api/#Vue-nextTick
 
-[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
 [9]: https://github.com/segmentio/nightmare#evaluatefn-arg1-arg2