Skip to content

Commit db00cab

Browse files
committed
synchronized with docs
1 parent 7df2a78 commit db00cab

38 files changed

Lines changed: 3785 additions & 4133 deletions

docs/ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ ai: {
533533
534534
* `maxLength`: the size of HTML to cut to not reach the token limit. 50K is the current default but you may try to increase it or even set it to null.
535535
* `simplify`: should we process HTML before sending to GPT. This will remove all non-interactive elements from HTML.
536-
* `minify`: shold HTML be additionally minified. This removed empty attributes, shortens notations, etc.
536+
* `minify`: should HTML be additionally minified. This removed empty attributes, shortens notations, etc.
537537
* `interactiveElements`: explicit list of all elements that are considered interactive.
538538
* `textElements`: elements that contain text which can be used for test automation.
539539
* `allowedAttrs`: explicit list of attributes that may be used to construct locators. If you use special `data-` attributes to enable locators, add them to the list.

docs/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ REST helper can send GET/POST/PATCH/etc requests to REST API endpoint:
148148
* [`I.sendPutRequest()`](/helpers/REST#sendPutRequest)
149149
* [`I.sendPatchRequest()`](/helpers/REST#sendPatchRequest)
150150
* [`I.sendDeleteRequest()`](/helpers/REST#sendDeleteRequest)
151+
* [`I.sendDeleteRequestWithPayload()`](/helpers/REST#sendDeleteRequestWithPayload)
151152
* ...
152153

153154
Authentication headers can be set in [helper's config](https://codecept.io/helpers/REST/#configuration) or per test with headers or special methods like `I.amBearerAuthenticated`.

docs/build/AI.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ const ai = require('../ai')
66
const standardActingHelpers = require('../plugin/standardActingHelpers')
77
const Container = require('../container')
88
const { splitByChunks, minifyHtml } = require('../html')
9-
const { beautify } = require('../utils.js')
10-
const output = require('../output.js')
9+
const { beautify } = require('../utils')
10+
const output = require('../output')
1111
const { registerVariable } = require('../pause')
1212

1313
const gtpRole = {

docs/build/ApiDataFactory.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const REST = require('./REST')
5151
*
5252
* module.exports = new Factory()
5353
* // no need to set id, it will be set by REST API
54-
* .attr('author', () => faker.name.findName())
54+
* .attr('author', () => faker.person.findName())
5555
* .attr('title', () => faker.lorem.sentence())
5656
* .attr('body', () => faker.lorem.paragraph());
5757
* ```

docs/build/Appium.js

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -434,8 +434,8 @@ class Appium extends Webdriver {
434434
async runOnIOS(caps, fn) {
435435
if (this.platform !== 'ios') return
436436
recorder.session.start('iOS-only actions')
437-
await this._runWithCaps(caps, fn)
438-
await recorder.add('restore from iOS session', () => recorder.session.restore())
437+
this._runWithCaps(caps, fn)
438+
recorder.add('restore from iOS session', () => recorder.session.restore())
439439
return recorder.promise()
440440
}
441441

@@ -476,8 +476,8 @@ class Appium extends Webdriver {
476476
async runOnAndroid(caps, fn) {
477477
if (this.platform !== 'android') return
478478
recorder.session.start('Android-only actions')
479-
await this._runWithCaps(caps, fn)
480-
await recorder.add('restore from Android session', () => recorder.session.restore())
479+
this._runWithCaps(caps, fn)
480+
recorder.add('restore from Android session', () => recorder.session.restore())
481481
return recorder.promise()
482482
}
483483

@@ -491,19 +491,17 @@ class Appium extends Webdriver {
491491
* });
492492
* ```
493493
*
494-
* @param {*} fn
495494
*/
496-
/* eslint-disable */
497-
async runInWeb(fn) {
495+
496+
async runInWeb() {
498497
if (!this.isWeb) return
499498
recorder.session.start('Web-only actions')
500499

501500
recorder.add('restore from Web session', () => recorder.session.restore(), true)
502501
return recorder.promise()
503502
}
504-
/* eslint-enable */
505503

506-
async _runWithCaps(caps, fn) {
504+
_runWithCaps(caps, fn) {
507505
if (typeof caps === 'object') {
508506
for (const key in caps) {
509507
// skip if capabilities do not match
@@ -1077,7 +1075,7 @@ class Appium extends Webdriver {
10771075
*
10781076
* Appium: support Android and iOS
10791077
*/
1080-
/* eslint-disable */
1078+
10811079
async swipe(locator, xoffset, yoffset, speed = 1000) {
10821080
onlyForApps.call(this)
10831081
const res = await this.browser.$(parseLocator.call(this, locator))
@@ -1087,7 +1085,6 @@ class Appium extends Webdriver {
10871085
y: (await res.getLocation()).y + yoffset,
10881086
})
10891087
}
1090-
/* eslint-enable */
10911088

10921089
/**
10931090
* Perform a swipe on the screen.

docs/build/ExpectHelper.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const output = require('../output.js')
1+
const output = require('../output')
22

33
let expect
44

docs/build/FileSystem.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const path = require('path')
33
const fs = require('fs')
44

55
const Helper = require('@codeceptjs/helper')
6-
const { fileExists } = require('../utils.js')
6+
const { fileExists } = require('../utils')
77
const { fileIncludes } = require('../assert/include')
88
const { fileEquals } = require('../assert/equal')
99

docs/build/GraphQLDataFactory.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ const GraphQL = require('./GraphQL')
5555
* input: { ...buildObj },
5656
* }))
5757
* // 'attr'-id can be left out depending on the GraphQl resolvers
58-
* .attr('name', () => faker.name.findName())
58+
* .attr('name', () => faker.person.findName())
5959
* .attr('email', () => faker.interact.email())
6060
* ```
6161
* For more options see [rosie documentation](https://github.com/rosiejs/rosie).

docs/build/Mochawesome.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ let currentTest
33
let currentSuite
44

55
const Helper = require('@codeceptjs/helper')
6-
const { clearString } = require('../utils.js')
6+
const { clearString } = require('../utils')
77

88
class Mochawesome extends Helper {
99
constructor(config) {

0 commit comments

Comments
 (0)