codeceptjs 2.3.4 → 2.4.1

package/docs/helpers/Detox.md

@@ -1,8 +1,12 @@
 ---
-id: Detox
+permalink: /helpers/Detox
+sidebar: auto
 title: Detox
 ---
 
+# Detox
+
+
 <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
 
 ## Detox
@@ -52,7 +56,7 @@ In `codecept.conf.js` enable Detox helper:
 ```js
 helpers: {
    Detox: {
-     require: '@codeceptjs/detox',
+     require: '@codeceptjs/detox-helper',
      configuration: '<detox-configuration-name>', 
    }   
 }
@@ -118,7 +122,7 @@ I.click({ ios: 'Save', android: 'SAVE' }, '#main'); // different texts on iOS an
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** 
--   `context` **([string][6] \| [object][7])**  (optional, default `null`)
+-   `context` **([string][6] \| [object][7] | null)**  (optional, default `null`)
 
 ### clickAtPoint
 
@@ -133,8 +137,8 @@ I.clickAtPoint('~save', 10, 10); // locate by accessibility id
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** 
--   `x` **int** horizontal offset (optional, default `0`)
--   `y` **int** vertical offset (optional, default `0`)
+-   `x` **[number][9]** horizontal offset (optional, default `0`)
+-   `y` **[number][9]** vertical offset (optional, default `0`)
 
 ### dontSee
 
@@ -150,7 +154,7 @@ I.dontSee('Record deleted', '~message');
 #### Parameters
 
 -   `text` **[string][6]** to check invisibility
--   `context` **([string][6] \| [object][7])** element in which to search for text (optional, default `null`)
+-   `context` **([string][6] \| [object][7] | null)** element in which to search for text (optional, default `null`)
 
 ### dontSeeElement
 
@@ -165,7 +169,7 @@ I.dontSeeElement('~edit', '#menu'); // element inside #menu
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** element to locate
--   `context` **([string][6] \| [object][7])** context element (optional, default `null`)
+-   `context` **([string][6] \| [object][7] | null)** context element (optional, default `null`)
 
 ### dontSeeElementExists
 
@@ -217,7 +221,7 @@ I.installApp();
 
 ### launchApp
 
-Launches an application. If application instance already exists, use [relaunchApp][9].
+Launches an application. If application instance already exists, use [relaunchApp][10].
 
 ```js
 I.launchApp();
@@ -236,8 +240,8 @@ I.longPress('Update', 2, '#menu'); // locate by text inside #menu, hold for 2 se
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** element to locate
--   `sec` **num** number of seconds to hold tap
--   `context` **([string][6] \| [object][7])** context element (optional, default `null`)
+-   `sec` **[number][9]** number of seconds to hold tap
+-   `context` **([string][6] \| [object][7] | null)** context element (optional, default `null`)
 
 ### multiTap
 
@@ -257,8 +261,8 @@ I.multiTap('Update', 2, '#menu'); // locate by id
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** element to locate
--   `num` **int** number of taps
--   `context` **([string][6] \| [object][7])** context element (optional, default `null`)
+-   `num` **[number][9]** number of taps
+-   `context` **([string][6] \| [object][7] | null)** context element (optional, default `null`)
 
 ### relaunchApp
 
@@ -281,7 +285,7 @@ I.runOnAndroid(() => {
 
 #### Parameters
 
--   `fn`  a function which will be executed on android
+-   `fn` **[Function][11]** a function which will be executed on android
 
 ### runOnIOS
 
@@ -296,7 +300,7 @@ I.runOnIOS(() => {
 
 #### Parameters
 
--   `fn`  a function which will be executed on iOS
+-   `fn` **[Function][11]** a function which will be executed on iOS
 
 ### saveScreenshot
 
@@ -308,8 +312,7 @@ I.saveScreenshot('main-window.png');
 
 #### Parameters
 
--   `name`  
--   `string`  name
+-   `name` **[string][6]** 
 
 ### scrollDown
 
@@ -373,7 +376,7 @@ I.see('Record deleted', '~message');
 #### Parameters
 
 -   `text` **[string][6]** to check visibility
--   `context` **([string][6] \| [object][7])** element inside which to search for text (optional, default `null`)
+-   `context` **([string][6] \| [object][7] | null)** element inside which to search for text (optional, default `null`)
 
 ### seeElement
 
@@ -388,7 +391,7 @@ I.seeElement('~edit', '#menu'); // element inside #menu
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** element to locate
--   `context` **([string][6] \| [object][7])** context element (optional, default `null`)
+-   `context` **([string][6] \| [object][7] | null)** context element (optional, default `null`)
 
 ### seeElementExists
 
@@ -492,7 +495,7 @@ Element can be located by its text or id or accessibility id.
 
 The second parameter is a context element to narrow the search.
 
-Same as [click][10]
+Same as [click][12]
 
 ```js
 I.tap('Login'); // locate by text
@@ -505,7 +508,7 @@ I.tap({ ios: 'Save', android: 'SAVE' }, '#main'); // different texts on iOS and
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** 
--   `context` **([string][6] \| [object][7])**  (optional, default `null`)
+-   `context` **([string][6] \| [object][7] | null)**  (optional, default `null`)
 
 ### wait
 
@@ -517,7 +520,7 @@ I.wait(2); // waits for 2 seconds
 
 #### Parameters
 
--   `sec` **int** number of seconds to wait
+-   `sec` **[number][9]** number of seconds to wait
 
 ### waitForElement
 
@@ -530,7 +533,7 @@ I.waitForElement('#message', 1); // wait for 1 second
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** an element to wait for
--   `sec` **int** number of seconds to wait, 5 by default (optional, default `5`)
+-   `sec` **[number][9]** number of seconds to wait, 5 by default (optional, default `5`)
 
 ### waitForElementVisible
 
@@ -543,7 +546,7 @@ I.waitForElementVisible('#message', 1); // wait for 1 second
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** an element to wait for
--   `sec` **int** number of seconds to wait (optional, default `5`)
+-   `sec` **[number][9]** number of seconds to wait (optional, default `5`)
 
 ### waitToHide
 
@@ -556,7 +559,7 @@ I.waitToHide('#message', 2); // wait for 2 seconds
 #### Parameters
 
 -   `locator` **([string][6] \| [object][7])** an element to wait for
--   `sec` **int** number of seconds to wait (optional, default `5`)
+-   `sec` **[number][9]** number of seconds to wait (optional, default `5`)
 
 [1]: https://github.com/wix/Detox
 
@@ -574,6 +577,10 @@ I.waitToHide('#message', 2); // wait for 2 seconds
 
 [8]: #tap
 
-[9]: #relaunchApp
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[10]: #relaunchApp
+
+[11]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
 
-[10]: #click
+[12]: #click

package/docs/helpers/FileSystem.md

@@ -1,5 +1,7 @@
 ---
-id: FileSystem
+permalink: /helpers/FileSystem
+editLink: false
+sidebar: auto
 title: FileSystem
 ---
 
@@ -7,7 +9,7 @@ title: FileSystem
 
 ## FileSystem
 
-Extends Helper
+**Extends Helper**
 
 Helper for testing filesystem.
 Can be easily used to check file structures:
@@ -28,7 +30,7 @@ Starts from a current directory
 
 #### Parameters
 
--   `openPath`  
+-   `openPath` **[string][1]** 
 
 ### dontSeeFileContentsEqual
 
@@ -36,8 +38,8 @@ Checks that contents of file found by `seeFile` doesn't equal to text.
 
 #### Parameters
 
--   `text`  
--   `encoding`  
+-   `text` **[string][1]** 
+-   `encoding` **[string][1]** 
 
 ### dontSeeInThisFile
 
@@ -45,8 +47,19 @@ Checks that file found by `seeFile` doesn't include text.
 
 #### Parameters
 
--   `text`  
--   `encoding`  
+-   `text` **[string][1]** 
+-   `encoding` **[string][1]** 
+
+### grabFileNames
+
+Returns file names in current directory.
+
+```js
+I.handleDownloads();
+I.click('Download Files');
+I.amInPath('output/downloads');
+const downloadedFileNames = I.grabFileNames();
+```
 
 ### seeFile
 
@@ -54,7 +67,7 @@ Checks that file exists
 
 #### Parameters
 
--   `name`  
+-   `name` **[string][1]** 
 
 ### seeFileContentsEqual
 
@@ -62,8 +75,23 @@ Checks that contents of file found by `seeFile` equal to text.
 
 #### Parameters
 
+-   `text` **[string][1]** 
+-   `encoding` **[string][1]** 
+
+### seeFileNameMatching
+
+Checks that file with a name including given text exists in the current directory.
+
+```js
+I.handleDownloads();
+I.click('Download as PDF');
+I.amInPath('output/downloads');
+I.seeFileNameMatching('.pdf');
+```
+
+#### Parameters
+
 -   `text`  
--   `encoding`  
 
 ### seeInThisFile
 
@@ -71,8 +99,8 @@ Checks that file found by `seeFile` includes a text.
 
 #### Parameters
 
--   `text`  
--   `encoding`  
+-   `text` **[string][1]** 
+-   `encoding` **[string][1]** 
 
 ### writeToFile
 
@@ -80,5 +108,7 @@ Writes test to file
 
 #### Parameters
 
--   `name`  
--   `text`  
+-   `name` **[string][1]** 
+-   `text` **[string][1]** 
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

package/docs/helpers/GraphQL.md

@@ -1,5 +1,7 @@
 ---
-id: GraphQL
+permalink: /helpers/GraphQL
+editLink: false
+sidebar: auto
 title: GraphQL
 ---
 
@@ -7,7 +9,7 @@ title: GraphQL
 
 ## GraphQL
 
-Extends Helper
+**Extends Helper**
 
 GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
 [Axios][1] library is used to perform requests.
@@ -47,22 +49,22 @@ this.helpers['GraphQL']._executeQuery({
 
 -   `config`  
 
-### \_executeQuery
+### _executeQuery
 
 Executes query via axios call
 
 #### Parameters
 
--   `request` [object][2] 
+-   `request` **[object][2]** 
 
-### \_prepareGraphQLRequest
+### _prepareGraphQLRequest
 
 Prepares request for axios call
 
 #### Parameters
 
--   `operation` [object][2] 
--   `headers` [object][2] 
+-   `operation` **[object][2]** 
+-   `headers` **[object][2]** 
 
 ### sendMutation
 
@@ -88,10 +90,10 @@ I.sendMutation(`
 
 #### Parameters
 
--   `mutation` [String][3] 
--   `variables` [object][2] that may go along with the mutation
--   `options` [object][2] are additional query options 
--   `headers` [object][2]  
+-   `mutation` **[String][3]** 
+-   `variables` **[object][2]** that may go along with the mutation
+-   `options` **[object][2]** are additional query options 
+-   `headers` **[object][2]**  
 
 ### sendQuery
 
@@ -110,10 +112,10 @@ const user = response.data.data;
 
 #### Parameters
 
--   `query` [String][3] 
--   `variables` [object][2] that may go along with the query
--   `options` [object][2] are additional query options 
--   `headers` [object][2]  
+-   `query` **[String][3]** 
+-   `variables` **[object][2]** that may go along with the query
+-   `options` **[object][2]** are additional query options 
+-   `headers` **[object][2]**  
 
 [1]: https://github.com/axios/axios
 

package/docs/helpers/GraphQLDataFactory.md

@@ -1,5 +1,7 @@
 ---
-id: GraphQLDataFactory
+permalink: /helpers/GraphQLDataFactory
+editLink: false
+sidebar: auto
 title: GraphQLDataFactory
 ---
 
@@ -7,7 +9,7 @@ title: GraphQLDataFactory
 
 ## GraphQLDataFactory
 
-Extends Helper
+**Extends Helper**
 
 Helper for managing remote data using GraphQL queries.
 Uses data generators like [rosie][1] or factory girl to create new record.
@@ -158,25 +160,25 @@ Data of created records are collected and used in the end of a test for the clea
 
 -   `config`  
 
-### \_requestCreate
+### _requestCreate
 
 Executes request to create a record to the GraphQL endpoint.
 Can be replaced from a custom helper.
 
 #### Parameters
 
--   `operation` [string][4] 
--   `variables` any to be sent along with the query
+-   `operation` **[string][4]** 
+-   `variables` **any** to be sent along with the query
 
-### \_requestDelete
+### _requestDelete
 
 Executes request to delete a record to the GraphQL endpoint.
 Can be replaced from a custom helper.
 
 #### Parameters
 
--   `operation` [string][4] 
--   `data` any of the record to be deleted.
+-   `operation` **[string][4]** 
+-   `data` **any** of the record to be deleted.
 
 ### mutateData
 
@@ -192,8 +194,8 @@ const user = await I.mutateData('createUser', { email: 'user@user.com'});
 
 #### Parameters
 
--   `operation` [string][4] to be performed
--   `params` any predefined parameters
+-   `operation` **[string][4]** to be performed
+-   `params` **any** predefined parameters
 
 ### mutateMultiple
 
@@ -209,9 +211,9 @@ I.mutateMultiple('createUser', 3, { age: 25 });
 
 #### Parameters
 
--   `operation` [string][4] 
--   `times` [number][5] 
--   `params` any 
+-   `operation` **[string][4]** 
+-   `times` **[number][5]** 
+-   `params` **any** 
 
 [1]: https://github.com/rosiejs/rosie
 

package/docs/helpers/Mochawesome.md

@@ -1,5 +1,7 @@
 ---
-id: Mochawesome
+permalink: /helpers/Mochawesome
+editLink: false
+sidebar: auto
 title: Mochawesome
 ---
 

package/docs/helpers/MockRequest.md

@@ -1,5 +1,7 @@
 ---
-id: MockRequest
+permalink: /helpers/MockRequest
+editLink: false
+sidebar: auto
 title: MockRequest
 ---
 
@@ -7,9 +9,9 @@ title: MockRequest
 
 ## MockRequest
 
-Extends Helper
+**Extends Helper**
 
-This helper allows to mock requests while running tests in Puppeteer or WebDriver.
+This helper allows to **mock requests while running tests in Puppeteer or WebDriver**.
 For instance, you can block calls to 3rd-party services like Google Analytics, CDNs.
 Another way of using is to emulate requests from server by passing prepared data.
 
@@ -34,7 +36,21 @@ helpers: {
 }
 ```
 
-The same can be done when using WebDriver helper..
+> Partially works with WebDriver helper
+
+[Polly config options][2] can be passed as well:
+
+```js
+// enable replay mode
+helpers: {
+ Puppeteer: {
+   // regular Puppeteer config here
+ },
+ MockRequest: {
+    mode: 'replay',
+ },
+}
+```
 
 ### Usage
 
@@ -44,26 +60,26 @@ Use `I.mockRequest` to intercept and mock requests.
 
 -   `config`  
 
-### \_checkAndStartMocking
+### _checkAndStartMocking
 
 Starts mocking if it's not started yet.
 
-### \_connectPuppeteer
+### _connectPuppeteer
 
 Creates a polly instance by registering puppeteer adapter with the instance
 
 #### Parameters
 
--   `title` any 
+-   `title` **any** 
 
-### \_connectWebDriver
+### _connectWebDriver
 
 Creates polly object in the browser window context using xhr and fetch adapters,
 after loading PollyJs and adapter scripts.
 
 #### Parameters
 
--   `title` any 
+-   `title` **any** 
 
 ### mockRequest
 
@@ -71,7 +87,7 @@ Mock response status
 
 ```js
 I.mockRequest('GET', '/api/users', 200);
-I.mockRequest('ANY', '/secretsRoutes/', 403);
+I.mockRequest('ANY', '/secretsRoutes/*', 403);
 I.mockRequest('POST', '/secrets', { secrets: 'fakeSecrets' });
 I.mockRequest('GET', '/api/users/1', 404, 'User not found');
 ```
@@ -84,10 +100,10 @@ I.mockRequest('GET', ['/secrets', '/v2/secrets'], 403);
 
 #### Parameters
 
--   `method` [string][2] request method. Can be `GET`, `POST`, `PUT`, etc or `ANY`.
--   `oneOrMoreUrls` ([string][2] \| [array][3]) url(s) to mock. Can be exact URL, a pattern, or an array of URLs.
--   `dataOrStatusCode` ([number][4] \| [string][2] \| [object][5]) status code when number provided. A response body otherwise
--   `additionalData` ([string][2] \| [object][5]) response body when a status code is set by previous parameter. 
+-   `method` **[string][3]** request method. Can be `GET`, `POST`, `PUT`, etc or `ANY`.
+-   `oneOrMoreUrls` **([string][3] | [Array][4]<[string][3]>)** url(s) to mock. Can be exact URL, a pattern, or an array of URLs.
+-   `dataOrStatusCode` **([number][5] | [string][3] | [object][6])** status code when number provided. A response body otherwise
+-   `additionalData` **([string][3] | [object][6])** response body when a status code is set by previous parameter. 
 
 ### startMocking
 
@@ -97,7 +113,7 @@ mocking requests.
 
 #### Parameters
 
--   `title` any  
+-   `title` **any**  
 
 ### stopMocking
 
@@ -105,10 +121,12 @@ Stops mocking requests.
 
 [1]: https://netflix.github.io/pollyjs/#/
 
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[2]: https://netflix.github.io/pollyjs/#/configuration?id=configuration
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
 
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
 
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object