codeceptjs 4.2.0-beta.4 → 4.2.1-beta.1

package/docs/helpers/REST.md

@@ -18,16 +18,16 @@ REST helper allows to send additional requests to the REST API during acceptance
 
 ## Configuration
 
-Type: [object][4]
+Type: [object][3]
 
 ### Properties
 
-*   `endpoint` **[string][3]?** API base URL
+*   `endpoint` **[string][2]?** API base URL
 *   `prettyPrintJson` **[boolean][6]?** pretty print json for response/request on console logs.
 *   `printCurl` **[boolean][6]?** print cURL request on console logs. False by default.
 *   `timeout` **[number][5]?** timeout for requests in milliseconds. 10000ms by default.
-*   `defaultHeaders` **[object][4]?** a list of default headers.
-*   `httpAgent` **[object][4]?** create an agent with SSL certificate
+*   `defaultHeaders` **[object][3]?** a list of default headers.
+*   `httpAgent` **[object][3]?** create an agent with SSL certificate
 *   `onRequest` **[function][7]?** an async function which can update request object.
 *   `onResponse` **[function][7]?** an async function which can update response object.
 *   `maxUploadFileSize` **[number][5]?** set the max content file size in MB when performing api calls.
@@ -102,24 +102,6 @@ this.helpers['REST']._executeRequest({
 
 *   `config`  
 
-### _executeRequest
-
-Executes axios request
-
-#### Parameters
-
-*   `request` **any** 
-
-Returns **[Promise][2]<any>** response
-
-### _url
-
-Generates url based on format sent (takes endpoint + url if latter lacks 'http')
-
-#### Parameters
-
-*   `url` **any**&#x20;
-
 ### amBearerAuthenticated
 
 Adds a header for Bearer authentication
@@ -131,7 +113,7 @@ I.amBearerAuthenticated(secret('heregoestoken'))
 
 #### Parameters
 
-*   `accessToken` **([string][3] | CodeceptJS.Secret)** Bearer access token
+*   `accessToken` **([string][2] | CodeceptJS.Secret)** Bearer access token
 
 ### haveRequestHeaders
 
@@ -139,7 +121,7 @@ Sets request headers for all requests of this test
 
 #### Parameters
 
-*   `headers` **[object][4]** headers list
+*   `headers` **[object][3]** headers list
 
 ### sendDeleteRequest
 
@@ -152,9 +134,9 @@ I.sendDeleteRequest('/api/users/1');
 #### Parameters
 
 *   `url` **any**&#x20;
-*   `headers` **[object][4]** the headers object to be sent. By default, it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default, it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### sendDeleteRequestWithPayload
 
@@ -168,9 +150,9 @@ I.sendDeleteRequestWithPayload('/api/users/1', { author: 'john' });
 
 *   `url` **any**&#x20;
 *   `payload` **any** the payload to be sent. By default it is sent as an empty object 
-*   `headers` **[object][4]** the headers object to be sent. By default, it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default, it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### sendGetRequest
 
@@ -183,9 +165,9 @@ I.sendGetRequest('/api/users.json');
 #### Parameters
 
 *   `url` **any**&#x20;
-*   `headers` **[object][4]** the headers object to be sent. By default, it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default, it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### sendHeadRequest
 
@@ -198,9 +180,9 @@ I.sendHeadRequest('/api/users.json');
 #### Parameters
 
 *   `url` **any**&#x20;
-*   `headers` **[object][4]** the headers object to be sent. By default, it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default, it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### sendPatchRequest
 
@@ -216,11 +198,11 @@ I.sendPatchRequest('/api/users.json', secret({ "email": "user@user.com" }));
 
 #### Parameters
 
-*   `url` **[string][3]**&#x20;
+*   `url` **[string][2]**&#x20;
 *   `payload` **any** the payload to be sent. By default it is sent as an empty object 
-*   `headers` **[object][4]** the headers object to be sent. By default it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### sendPostRequest
 
@@ -238,9 +220,9 @@ I.sendPostRequest('/api/users.json', secret({ "email": "user@user.com" }));
 
 *   `url` **any**&#x20;
 *   `payload` **any** the payload to be sent. By default, it is sent as an empty object 
-*   `headers` **[object][4]** the headers object to be sent. By default, it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default, it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### sendPutRequest
 
@@ -256,11 +238,11 @@ I.sendPutRequest('/api/users.json', secret({ "email": "user@user.com" }));
 
 #### Parameters
 
-*   `url` **[string][3]**&#x20;
+*   `url` **[string][2]**&#x20;
 *   `payload` **any** the payload to be sent. By default it is sent as an empty object 
-*   `headers` **[object][4]** the headers object to be sent. By default it is sent as an empty object 
+*   `headers` **[object][3]** the headers object to be sent. By default it is sent as an empty object 
 
-Returns **[Promise][2]<any>** response
+Returns **[Promise][4]<any>** response
 
 ### setRequestTimeout
 
@@ -274,13 +256,31 @@ I.setRequestTimeout(10000); // In milliseconds
 
 *   `newTimeout` **[number][5]** timeout in milliseconds
 
+### _executeRequest
+
+Executes axios request
+
+#### Parameters
+
+*   `request` **any**&#x20;
+
+Returns **[Promise][4]<any>** response
+
+### _url
+
+Generates url based on format sent (takes endpoint + url if latter lacks 'http')
+
+#### Parameters
+
+*   `url` **any**&#x20;
+
 [1]: https://github.com/axios/axios
 
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
 [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number