codeceptjs 3.5.10 → 3.5.12-beta.1

package/docs/helpers/Expect.md

@@ -1,275 +0,0 @@
----
-permalink: /helpers/Expect
-editLink: false
-sidebar: auto
-title: Expect
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## ExpectHelper
-
-This helper allows performing assertions based on Chai.
-
-### Examples
-
-Zero-configuration when paired with other helpers like REST, Playwright:
-
-```js
-// inside codecept.conf.js
-{
-  helpers: {
-    Playwright: {...},
-    ExpectHelper: {},
-  }
-}
-```
-
-## Methods
-
-### expectAbove
-
-#### Parameters
-
--   `targetData` **any** 
--   `aboveThan` **any** number | Date
--   `customErrorMsg` **any**  
-
-### expectBelow
-
-#### Parameters
-
--   `targetData` **any** 
--   `belowThan` **any** number | Date
--   `customErrorMsg` **any**  
-
-### expectContain
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValueToContain` **any** 
--   `customErrorMsg` **any**  
-
-### expectDeepEqual
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `customErrorMsg` **any**  
-
-### expectDeepEqualExcluding
-
-expects members of two JSON objects are deeply equal excluding some properties
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `fieldsToExclude` **any** 
--   `customErrorMsg` **any**  
-
-### expectDeepIncludeMembers
-
-expects an array to be a superset of another array
-
-#### Parameters
-
--   `superset` **any** 
--   `set` **any** 
--   `customErrorMsg` **any**  
-
-### expectDeepMembers
-
-expects members of two arrays are deeply equal
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `customErrorMsg` **any**  
-
-### expectEmpty
-
-#### Parameters
-
--   `targetData` **any** 
--   `customErrorMsg` **any**  
-
-### expectEndsWith
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValueToEndWith` **any** 
--   `customErrorMsg` **any**  
-
-### expectEqual
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `customErrorMsg` **any**  
-
-### expectEqualIgnoreCase
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `customErrorMsg` **any**  
-
-### expectFalse
-
-#### Parameters
-
--   `targetData` **any** 
--   `customErrorMsg` **any**  
-
-### expectHasAProperty
-
-#### Parameters
-
--   `targetData` **any** 
--   `propertyName` **any** 
--   `customErrorMsg` **any**  
-
-### expectHasProperty
-
-#### Parameters
-
--   `targetData` **any** 
--   `propertyName` **any** 
--   `customErrorMsg` **any**  
-
-### expectJsonSchema
-
-#### Parameters
-
--   `targetData` **any** 
--   `jsonSchema` **any** 
--   `customErrorMsg` **any**  
-
-### expectJsonSchemaUsingAJV
-
-#### Parameters
-
--   `targetData` **any** 
--   `jsonSchema` **any** 
--   `customErrorMsg` **any**  
--   `ajvOptions` **any** Pass AJV options 
-
-### expectLengthAboveThan
-
-#### Parameters
-
--   `targetData` **any** 
--   `lengthAboveThan` **any** 
--   `customErrorMsg` **any**  
-
-### expectLengthBelowThan
-
-#### Parameters
-
--   `targetData` **any** 
--   `lengthBelowThan` **any** 
--   `customErrorMsg` **any**  
-
-### expectLengthOf
-
-#### Parameters
-
--   `targetData` **any** 
--   `length` **any** 
--   `customErrorMsg` **any**  
-
-### expectMatchesPattern
-
-expects a JSON object matches a provided pattern
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedPattern` **any** 
--   `customErrorMsg` **any**  
-
-### expectMatchRegex
-
-#### Parameters
-
--   `targetData` **any** 
--   `regex` **any** 
--   `customErrorMsg` **any**  
-
-### expectNotContain
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValueToNotContain` **any** 
--   `customErrorMsg` **any**  
-
-### expectNotDeepEqual
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `customErrorMsg` **any**  
-
-### expectNotEndsWith
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValueToNotEndWith` **any** 
--   `customErrorMsg` **any**  
-
-### expectNotEqual
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValue` **any** 
--   `customErrorMsg` **any**  
-
-### expectNotStartsWith
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValueToNotStartWith` **any** 
--   `customErrorMsg` **any**  
-
-### expectStartsWith
-
-#### Parameters
-
--   `actualValue` **any** 
--   `expectedValueToStartWith` **any** 
--   `customErrorMsg` **any**  
-
-### expectToBeA
-
-#### Parameters
-
--   `targetData` **any** 
--   `type` **any** 
--   `customErrorMsg` **any**  
-
-### expectToBeAn
-
-#### Parameters
-
--   `targetData` **any** 
--   `type` **any** 
--   `customErrorMsg` **any**  
-
-### expectTrue
-
-#### Parameters
-
--   `targetData` **any** 
--   `customErrorMsg` **any**  

package/docs/helpers/FileSystem.md

@@ -1,152 +0,0 @@
----
-permalink: /helpers/FileSystem
-editLink: false
-sidebar: auto
-title: FileSystem
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## FileSystem
-
-**Extends Helper**
-
-Helper for testing filesystem.
-Can be easily used to check file structures:
-
-```js
-I.amInPath('test');
-I.seeFile('codecept.js');
-I.seeInThisFile('FileSystem');
-I.dontSeeInThisFile("WebDriver");
-```
-
-## Configuration
-
-Enable helper in config file:
-
-```js
-helpers: {
-    FileSystem: {},
-}
-```
-
-## Methods
-
-### amInPath
-
-Enters a directory In local filesystem.
-Starts from a current directory
-
-#### Parameters
-
--   `openPath` **[string][1]** 
-
-### dontSeeFileContentsEqual
-
-Checks that contents of file found by `seeFile` doesn't equal to text.
-
-#### Parameters
-
--   `text` **[string][1]** 
--   `encoding` **[string][1]**  
-
-### dontSeeInThisFile
-
-Checks that file found by `seeFile` doesn't include text.
-
-#### Parameters
-
--   `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
-
-Checks that file exists
-
-#### Parameters
-
--   `name` **[string][1]** 
-
-### seeFileContentsEqual
-
-Checks that contents of file found by `seeFile` equal to text.
-
-#### Parameters
-
--   `text` **[string][1]** 
--   `encoding` **[string][1]**  
-
-### seeFileContentsEqualReferenceFile
-
-Checks that contents of the file found by `seeFile` equal to contents of the file at `pathToReferenceFile`.
-
-#### Parameters
-
--   `pathToReferenceFile` **[string][1]** 
--   `encoding` **[string][1]**  
--   `encodingReference` **[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` **[string][1]** 
-
-### seeInThisFile
-
-Checks that file found by `seeFile` includes a text.
-
-#### Parameters
-
--   `text` **[string][1]** 
--   `encoding` **[string][1]**  
-
-### waitForFile
-
-Waits for the file to be present in the current directory.
-
-```js
-I.handleDownloads('downloads/largeFilesName.txt');
-I.click('Download large File');
-I.amInPath('output/downloads');
-I.waitForFile('largeFilesName.txt', 10); // wait 10 seconds for file
-```
-
-#### Parameters
-
--   `name` **[string][1]** 
--   `sec` **[number][2]** seconds to wait 
-
-### writeToFile
-
-Writes text to file
-
-#### Parameters
-
--   `name` **[string][1]** 
--   `text` **[string][1]** 
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

package/docs/helpers/GraphQL.md

@@ -1,151 +0,0 @@
----
-permalink: /helpers/GraphQL
-editLink: false
-sidebar: auto
-title: GraphQL
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## GraphQL
-
-**Extends Helper**
-
-GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
-[Axios][1] library is used to perform requests.
-
-## Configuration
-
--   endpoint: GraphQL base URL
--   timeout: timeout for requests in milliseconds. 10000ms by default
--   defaultHeaders: a list of default headers
--   onRequest: a async function which can update request object.
-
-## Example
-
-```js
-GraphQL: {
-   endpoint: 'http://site.com/graphql/',
-   onRequest: (request) => {
-     request.headers.auth = '123';
-   }
-}
-```
-
-## Access From Helpers
-
-Send GraphQL requests by accessing `_executeQuery` method:
-
-```js
-this.helpers['GraphQL']._executeQuery({
-   url,
-   data,
-});
-```
-
-## Methods
-
-### Parameters
-
--   `config`  
-
-### _executeQuery
-
-Executes query via axios call
-
-#### Parameters
-
--   `request` **[object][2]** 
-
-### _prepareGraphQLRequest
-
-Prepares request for axios call
-
-#### Parameters
-
--   `operation` **[object][2]** 
--   `headers` **[object][2]** 
-
-Returns **[object][2]** graphQLRequest
-
-### amBearerAuthenticated
-
-Adds a header for Bearer authentication
-
-```js
-// we use secret function to hide token from logs
-I.amBearerAuthenticated(secret('heregoestoken'))
-```
-
-#### Parameters
-
--   `accessToken` **([string][3] | CodeceptJS.Secret)** Bearer access token
-
-### haveRequestHeaders
-
-Sets request headers for all requests of this test
-
-#### Parameters
-
--   `headers` **[object][2]** headers list
-
-### sendMutation
-
-Send query to GraphQL endpoint over http
-
-```js
-I.sendMutation(`
-      mutation createUser($user: UserInput!) {
-         createUser(user: $user) {
-           id
-           name
-           email
-         }
-       }
-   `,
-  { user: {
-      name: 'John Doe',
-      email: 'john@xmail.com'
-    }
-  },
-});
-```
-
-#### Parameters
-
--   `mutation` **[String][3]** 
--   `variables` **[object][2]?** that may go along with the mutation
--   `options` **[object][2]?** are additional query options 
--   `headers` **[object][2]?**  
-
-Returns **any** Promise<any>
-
-### sendQuery
-
-Send query to GraphQL endpoint over http.
-Returns a response as a promise.
-
-```js
-const response = await I.sendQuery('{ users { name email }}');
-// with variables
-const response = await I.sendQuery(
- 'query getUser($id: ID) { user(id: $id) { name email }}',
- { id: 1 },
-)
-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]?**  
-
-Returns **any** Promise<any>
-
-[1]: https://github.com/axios/axios
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String