From fd497a994db5c5351a0ab1bceeb24f2d9465e9f8 Mon Sep 17 00:00:00 2001 From: DavertMik Date: Sat, 4 Jan 2025 04:38:27 +0200 Subject: [PATCH] fixed def --- docs/plugins.md | 12 ++++++------ typings/jsdoc.conf.js | 9 ++++++--- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/plugins.md b/docs/plugins.md index 30e3b5e69..155550f7d 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -285,7 +285,7 @@ Scenario('login', async ({ I, login }) => { Add descriptive nested steps for your tests: ```js -Scenario('project update test', async (I) => { +Scenario('project update test', async I => { __`Given` const projectId = await I.have('project') @@ -559,7 +559,7 @@ Example of usage: ```js // this example works with Playwright and Puppeteer helper -await eachElement('click all checkboxes', 'form input[type=checkbox]', async (el) => { +await eachElement('click all checkboxes', 'form input[type=checkbox]', async el => { await el.click() }) ``` @@ -578,7 +578,7 @@ Check all elements for visibility: ```js // this example works with Playwright and Puppeteer helper const assert = require('assert') -await eachElement('check all items are visible', '.item', async (el) => { +await eachElement('check all items are visible', '.item', async el => { assert(await el.isVisible()) }) ``` @@ -750,7 +750,7 @@ Use scenario configuration to disable plugin for a test ```js Scenario('scenario tite', () => { // test goes here -}).config((test) => (test.disableRetryFailedStep = true)) +}).config(test => (test.disableRetryFailedStep = true)) ``` ### Parameters @@ -775,7 +775,7 @@ Use it in your tests: ```js // retry these steps 5 times before failing -await retryTo((tryNum) => { +await retryTo(tryNum => { I.switchTo('#editor frame') I.click('Open') I.see('Opened') @@ -787,7 +787,7 @@ Set polling interval as 3rd argument (200ms by default): ```js // retry these steps 5 times before failing await retryTo( - (tryNum) => { + tryNum => { I.switchTo('#editor frame') I.click('Open') I.see('Opened') diff --git a/typings/jsdoc.conf.js b/typings/jsdoc.conf.js index f14ec41a4..3ff9b4c04 100644 --- a/typings/jsdoc.conf.js +++ b/typings/jsdoc.conf.js @@ -10,7 +10,6 @@ module.exports = { './lib/data/dataTableArgument.js', './lib/event.js', './lib/index.js', - './lib/interfaces', './lib/locator.js', './lib/output.js', './lib/pause.js', @@ -19,7 +18,11 @@ module.exports = { './lib/session.js', './lib/step.js', './lib/store.js', - './lib/ui.js', + './lib/mocha/ui.js', + './lib/mocha/featureConfig.js', + './lib/mocha/scenarioConfig.js', + './lib/mocha/bdd.js', + './lib/mocha/hooks.js', './lib/within.js', require.resolve('@codeceptjs/detox-helper'), require.resolve('@codeceptjs/helper'), @@ -31,4 +34,4 @@ module.exports = { destination: './typings/', }, plugins: ['jsdoc.namespace.js', 'jsdoc-typeof-plugin'], -}; +}