codeceptjs 3.0.3 → 3.0.7

package/docs/locators.md

@@ -21,7 +21,7 @@ If the locator is an object, it should have a single element, with the key signi
 
 Examples:
 
-* {permalink: /'foo'} matches `<div id="foo">`
+* {id: 'foo'} matches `<div id="foo">`
 * {name: 'foo'} matches `<div name="foo">`
 * {css: 'input[type=input][value=foo]'} matches `<input type="input" value="foo">`
 * {xpath: "//input[@type='submit'][contains(@value, 'foo')]"} matches `<input type="submit" value="foobar">`
@@ -229,7 +229,7 @@ locate('button').after('.btn-cancel');
 
 ID locators are best to select the exact semantic element in web and mobile testing:
 
-* `#user` or `{ permalink: /'user' }` finds element with id="user"
+* `#user` or `{ id: 'user' }` finds element with id="user"
 * `~user` finds element with accessibility id "user" (in Mobile testing) or with `aria-label=user`.
 
 ## Custom Locators
@@ -297,8 +297,35 @@ codeceptjs.locator.addFilter((providedLocator, locatorObj) => {
 ```
 New locator strategy is ready to use:
 
+
 ```js
 I.click('=Login');
 ```
 
+#### Custom Strategy Locators
+
+CodeceptJS provides the option to specify custom locators that uses Custom Locator Strategies defined in the WebDriver configuration. It uses the WebDriverIO's [custom$](https://webdriver.io/docs/api/browser/custom$.html) locators internally to locate the elements on page.
+To use the defined Custom Locator Strategy add your custom strategy to your configuration.
+
+```js
+// in codecept.conf.js
+
+const myStrat = (selector) => {
+  return document.querySelectorAll(selector)
+}
+
+// under WebDriver Helpers Configuration
+WebDriver: {
+  ...
+  customLocatorStrategies: {
+    custom: myStrat
+  }
+}
+```
+
+```js
+I.click({custom: 'my-shadow-element-unique-css'})
+```
+
+
 > For more details on locator object see [Locator](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/locator.js) class implementation.

package/docs/mobile-react-native-locators.md

@@ -46,14 +46,14 @@ You could do it just by changing `automationName` in the `helpers` section of th
 ```
 Then you could locate components using XPath expression:
 ```js
-I.tap({android: /'//*[@view-tag="someButton"]', ios: '~someButton'})
+I.tap({android: '//*[@view-tag="someButton"]', ios: '~someButton'})
 ```
 This way test would work for both platforms without any changes in code.
 To simplify things further you could write a helper function:
 ```js
 function tid(id) {
   return {
-    android: /`//*[@view-tag="${id}"]`,
+    android: `//*[@view-tag="${id}"]`,
     ios: '~' + id
   }
 }

package/docs/mobile.md

@@ -19,7 +19,7 @@ I.see('davert@codecept.io', '~email of the customer'));
 I.clearField('~email of the customer'));
 I.dontSee('Nothing special', '~email of the customer'));
 I.seeElement({
-  android: /'android.widget.Button',
+  android: 'android.widget.Button',
   ios: '//UIAApplication[1]/UIAWindow[1]/UIAButton[1]'
 });
 ```
@@ -118,6 +118,7 @@ helpers: {
     app: "bs://<hashed app-id>",
     host: "hub-cloud.browserstack.com",
     port: 4444,
+    platform: "ios",
     user: "BROWSERSTACK_USER",
     key: "BROWSERSTACK_KEY",
     device: "iPhone 7"
@@ -262,7 +263,7 @@ It is often happen that mobile applications behave similarly on different platfo
 CodeceptJS provides a way to specify different locators for Android and iOS platforms:
 
 ```js
-I.click({android: /'//android.widget.Button', ios: '//UIAApplication[1]/UIAWindow[1]/UIAButton[1]'});
+I.click({android: '//android.widget.Button', ios: '//UIAApplication[1]/UIAWindow[1]/UIAButton[1]'});
 ```
 
 In case some code should be executed on one platform and ignored on others use `runOnAndroid` and `runOnIOS` methods:
@@ -293,4 +294,3 @@ Just as you can specify android, and ios-specific locators, you can do so for we
 ```js
 I.click({web: '#login', ios: '//UIAApplication[1]/UIAWindow[1]/UIAButton[1]'});
 ```
-

package/docs/nightmare.md

@@ -221,8 +221,3 @@ I.seeAttributeContains('#main img', 'src', '/cat.jpg');
 This sample assertion used `_locate` helper method which searched for elements
 by CSS/XPath or a strict locator. Then `browser.evaluate` method was called to
 use locate found elements on a page and return attribute from the first of them.
-
-## Additional Links
-
-* [Nightmare Tutorial](http://codenroll.it/acceptance-testing-with-codecept-js/) by jploskonka.
-

package/docs/pageobjects.md

@@ -32,7 +32,9 @@ const { I, myPage, mySteps } = inject();
 // inject objects for a test by name
 Scenario('sample test', ({ I, myPage, mySteps }) => {
   // ...
-  }
+});
+```
+
 ## Actor
 
 During initialization you were asked to create a custom steps file. If you accepted this option, you are now able to use the `custom_steps.js` file to extend `I`. See how the `login` method can be added to `I`:

package/docs/parallel.md

@@ -26,7 +26,7 @@ This command is similar to `run`, however, steps output can't be shown in worker
 
 Each worker spins an instance of CodeceptJS, executes a group of tests, and sends back report to the main process.
 
-By default the tests are assigned one by one to the avaible workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assigne the suites one by one to the workers.
+By default the tests are assigned one by one to the available workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assigne the suites one by one to the workers.
 
 ```sh
 npx codeceptjs run-workers --suites 2
@@ -74,9 +74,11 @@ const testGroups = workers.createGroupsOfSuites(2);
 const browsers = ['firefox', 'chrome'];
 
 const configs = browsers.map(browser => {
-  return helpers: {
-    WebDriver: { browser }
-  }
+  return {
+    helpers: {
+      WebDriver: { browser }
+    }
+  };
 });
 
 for (const config of configs) {
@@ -176,24 +178,41 @@ customWorkers.on(event.all.result, () => {
 });
 ```
 
+### Emitting messages to the parent worker
+
+Child workers can send non test events to the main process. This is useful if you want to pass along information not related to the tests event cycles itself such as `event.test.success`.
+
+```js
+// inside main process
+// listen for any non test related events
+workers.on('message', (data) => {
+  console.log(data)
+});
+
+workers.on(event.all.result, (status, completedTests, workerStats) => {
+  // logic
+});
+```
+
 ## Sharing Data Between Workers
 
-NodeJS Workers can communicate between each other via messaging system. It may happen that you want to pass some data from one of workers to other. For instance, you may want to share user credentials accross all tests. Data will be appended to a container.
+NodeJS Workers can communicate between each other via messaging system. It may happen that you want to pass some data from one of the workers to other. For instance, you may want to share user credentials accross all tests. Data will be appended to a container.
 
-However, you can't access uninitialized data from a container, so to start, you need to initialized data first. Inside `bootstrap` function of the config we execute the `share` function with `local: true` to initialize value locally:
+However, you can't access uninitialized data from a container, so to start, you need to initialize data first. Inside `bootstrap` function of the config we execute the `share` to initialize value:
 
 
 ```js
 // inside codecept.conf.js
 exports.config = {
   bootstrap() {
-    // append empty userData to container for current worker
-    share({ userData: false }, { local: true });
+    // append empty userData to container
+    share({ userData: false });
   }
 }
 ```
+
 Now each worker has `userData` inside a container. However, it is empty.
-When you obtain real data in one of tests you can this data accross tests. Use `inject` function to access data inside a container:
+When you obtain real data in one of the tests you can now `share` this data accross tests. Use `inject` function to access data inside a container:
 
 ```js
 // get current value of userData
@@ -202,6 +221,12 @@ let { userData } = inject();
 if (!userData) {
   userData = { name: 'user', password: '123456' };
   // now new userData will be shared accross all workers
-  share(userData);
+  share({userData : userData});
 }
 ```
+
+If you want to share data only within same worker, and not across all workers, you need to add option `local: true` every time you run `share` 
+
+```js
+share({ userData: false }, {local: true });
+```

package/docs/playwright.md

@@ -5,9 +5,9 @@ title: Testing with Playwright
 
 # Testing with Playwright <Badge text="Since 2.5" type="warning"/>
 
-Playwright is a Node library to automate the [Chromium](https://www.chromium.org/Home), [WebKit](https://webkit.org/) and [Firefox](https://www.mozilla.org/en-US/firefox/new/) browsers with a single API. It enables **cross-browser** web automation that is **ever-green**, **capable**, **reliable** and **fast**.
+Playwright is a Node library to automate the [Chromium](https://www.chromium.org/Home), [WebKit](https://webkit.org/) and [Firefox](https://www.mozilla.org/en-US/firefox/new/) browsers as well as [Electron](https://www.electronjs.org/) apps with a single API. It enables **cross-browser** web automation that is **ever-green**, **capable**, **reliable** and **fast**.
 
-Playwright was built similarly to [Puppeteer](https://github.com/puppeteer/puppeteer), using its API and so is very different in usage. However, Playwright has cross browser support with better design for test automaiton.
+Playwright was built similarly to [Puppeteer](https://github.com/puppeteer/puppeteer), using its API and so is very different in usage. However, Playwright has cross browser support with better design for test automation.
 
 Take a look at a sample test:
 
@@ -202,7 +202,7 @@ CodeceptJS allows you to implement custom actions like `I.createTodo` or use **P
 
 ## Multi Session Testing
 
-TO launch additional browser context (or incognito window) use `session` command.
+To launch additional browser context (or incognito window) use `session` command.
 
 ```js
 Scenario('I try to open this site as anonymous user', ({ I }) => {
@@ -217,13 +217,60 @@ Scenario('I try to open this site as anonymous user', ({ I }) => {
 
 > ℹ Learn more about [multi-session testing](/basics/#multiple-sessions)
 
+## Electron Testing
+
+CodeceptJS allows you to make use of [Playwright's Electron flavor](https://github.com/microsoft/playwright/blob/master/packages/playwright-electron/README.md).
+To use this functionality, all you need to do is set the browser to `electron` in the CodeceptJS configuration file and, according to the [Playwright BrowserType API](https://playwright.dev/docs/api/class-browsertype/#browsertypelaunchoptions), set the launch options to point to your Electron application.
+
+`main.js` - main Electron application file
+```js
+const { app, BrowserWindow } = require("electron");
+
+function createWindow() {
+  const window = new BrowserWindow({ width: 800, height: 600 });
+  window.loadURL("https://example.com");
+}
+
+app.whenReady().then(createWindow);
+```
+
+`codecept.conf.js` - CodeceptJS configuration file
+```js
+const path = require("path");
+
+exports.config = {
+  helpers: {
+    Playwright: {
+      browser: "electron",
+      electron: {
+        executablePath: require("electron"),
+        args: [path.join(__dirname, "main.js")],
+      },
+    },
+  },
+  // rest of config
+}
+```
+
+### Headless Mode
+
+With Electron, headless mode must be set when creating the window. Therefore, CodeceptJS's `show` configuration parameter will not work. However, you can set it in the `main.js` file as shown below:
+
+```js
+function createWindow() {
+  const window = new BrowserWindow({ width: 800, height: 600, show: false });
+  window.loadURL("https://example.com");
+}
+```
+
+
 ## Device Emulation
 
 Playwright can emulate browsers of mobile devices. Instead of paying for expensive devices for mobile tests you can adjust Playwright settings so it could emulate mobile browsers on iPhone, Samsung Galaxy, etc.
 
 Device emulation can be enabled in CodeceptJS globally in a config or per session.
 
-Playwright contains a [list of predefined devices](https://github.com/Microsoft/playwright/blob/master/src/deviceDescriptors.ts) to emulate, for instance this is how you can enable iPhone 6 emulation for all tests:
+Playwright contains a [list of predefined devices](https://github.com/microsoft/playwright/blob/master/src/server/deviceDescriptors.js) to emulate, for instance this is how you can enable iPhone 6 emulation for all tests:
 
 ```js
 const { devices } = require('playwright');
@@ -235,7 +282,7 @@ helpers: {
   }
 }
 ```
-To adjust browser settings you can pass [custom options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewcontextoptions)
+To adjust browser settings you can pass [custom options](https://github.com/microsoft/playwright/blob/master/docs/src/api/class-browsercontext.md)
 
 ```js
 helpers: {
@@ -275,7 +322,7 @@ Playwright can be added to GitHub Actions using [official action](https://github
 
 ## Accessing Playwright API
 
-To get [Playwright API](https://github.com/microsoft/playwright/blob/master/docs/api.md) inside a test use `I.usePlaywrightTo` method with a callback.
+To get [Playwright API](https://github.com/microsoft/playwright/tree/master/docs/src/api) inside a test use `I.usePlaywrightTo` method with a callback.
 To keep test readable provide a description of a callback inside the first parameter.
 
 ```js
@@ -338,6 +385,6 @@ async setPermissions() {
 }
 ```
 
-> [▶ Learn more about BrowserContext](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browsercontext)
+> [▶ Learn more about BrowserContext](https://github.com/microsoft/playwright/blob/master/docs/src/api/class-browsercontext.md)
 
-> [▶ Learn more about Helpers](http://codecept.io/helpers/)
+> [▶ Learn more about Helpers](https://codecept.io/helpers/)

package/docs/plugins.md

@@ -478,9 +478,49 @@ I.click('=sign-up'); // matches => [data-qa=sign-up]
 
 -   `config`  
 
+## fakerTransform
+
+Use the [faker.js][4] package to generate fake data inside examples on your gherkin tests
+
+![Faker.js][5]
+
+#### Usage
+
+To start please install `faker.js` package
+
+    npm install -D faker
+
+    yarn add -D faker
+
+Add this plugin to config file:
+
+```js
+plugins: {
+   fakerTransform: {
+     enabled: true
+   }
+}
+```
+
+Add the faker API using a mustache string format inside examples tables in your gherkin scenario outline
+
+```feature
+Scenario Outline: ...
+            Given ...
+             When ...
+             Then ...
+        Examples:
+  | productName          | customer              | email              | anythingMore |
+  | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |
+```
+
+### Parameters
+
+-   `config`  
+
 ## pauseOnFail
 
-Automatically launches [interactive pause][4] when a test fails.
+Automatically launches [interactive pause][6] when a test fails.
 
 Useful for debugging flaky tests on local environment.
 Add this plugin to config file:
@@ -527,9 +567,9 @@ Possible config options:
 
     Links:
 
--   [https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage][5]
--   [https://github.com/istanbuljs/puppeteer-to-istanbul][6]
--   [https://github.com/gotwarlost/istanbul][7]
+-   [https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage][7]
+-   [https://github.com/istanbuljs/puppeteer-to-istanbul][8]
+-   [https://github.com/gotwarlost/istanbul][9]
 
 ### Parameters
 
@@ -633,14 +673,14 @@ Possible config options:
 
 ## selenoid
 
-[Selenoid][8] plugin automatically starts browsers and video recording.
+[Selenoid][10] plugin automatically starts browsers and video recording.
 Works with WebDriver helper.
 
 ### Prerequisite
 
 This plugin **requires Docker** to be installed.
 
-> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][9] tool from Selenoid
+> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][11] tool from Selenoid
 
 ### Usage
 
@@ -669,7 +709,7 @@ plugins: {
   }
 ```
 
-When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][10] and start Selenoid automatically.
+When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][12] and start Selenoid automatically.
 It will also create `browsers.json` file required by Selenoid.
 
 In automatic mode the latest version of browser will be used for tests. It is recommended to specify exact version of each browser inside `browsers.json` file.
@@ -681,10 +721,10 @@ In automatic mode the latest version of browser will be used for tests. It is re
 While this plugin can create containers for you for better control it is recommended to create and launch containers manually.
 This is especially useful for Continous Integration server as you can configure scaling for Selenoid containers.
 
-> Use [Selenoid Configuration Manager][9] to create and start containers semi-automatically.
+> Use [Selenoid Configuration Manager][11] to create and start containers semi-automatically.
 
 1.  Create `browsers.json` file in the same directory `codecept.conf.js` is located
-    [Refer to Selenoid documentation][11] to know more about browsers.json.
+    [Refer to Selenoid documentation][13] to know more about browsers.json.
 
 _Sample browsers.json_
 
@@ -709,7 +749,7 @@ _Sample browsers.json_
 
 2.  Create Selenoid container
 
-Run the following command to create a container. To know more [refer here][12]
+Run the following command to create a container. To know more [refer here][14]
 
 ```bash
 docker create                                    \
@@ -742,7 +782,7 @@ When `allure` plugin is enabled a video is attached to report automatically.
 | enableVideo      | Enable video recording and use `video` folder of output (default: false)       |
 | enableLog        | Enable log recording and use `logs` folder of output (default: false)          |
 | deletePassed     | Delete video and logs of passed tests (default : true)                         |
-| additionalParams | example: `additionalParams: '--env TEST=test'` [Refer here][13] to know more   |
+| additionalParams | example: `additionalParams: '--env TEST=test'` [Refer here][15] to know more   |
 
 ### Parameters
 
@@ -750,7 +790,7 @@ When `allure` plugin is enabled a video is attached to report automatically.
 
 ## stepByStepReport
 
-![step-by-step-report][14]
+![step-by-step-report][16]
 
 Generates step by step report for a test.
 After each step in a test a screenshot is created. After test executed screenshots are combined into slideshow.
@@ -857,7 +897,7 @@ This plugin allows to run webdriverio services like:
 -   browserstack
 -   appium
 
-A complete list of all available services can be found on [webdriverio website][15].
+A complete list of all available services can be found on [webdriverio website][17].
 
 #### Setup
 
@@ -869,7 +909,7 @@ See examples below:
 
 #### Selenium Standalone Service
 
-Install `@wdio/selenium-standalone-service` package, as [described here][16].
+Install `@wdio/selenium-standalone-service` package, as [described here][18].
 It is important to make sure it is compatible with current webdriverio version.
 
 Enable `wdio` plugin in plugins list and add `selenium-standalone` service:
@@ -888,7 +928,7 @@ Please note, this service can be used with Protractor helper as well!
 
 #### Sauce Service
 
-Install `@wdio/sauce-service` package, as [described here][17].
+Install `@wdio/sauce-service` package, as [described here][19].
 It is important to make sure it is compatible with current webdriverio version.
 
 Enable `wdio` plugin in plugins list and add `sauce` service:
@@ -924,30 +964,34 @@ In the same manner additional services from webdriverio can be installed, enable
 
 [3]: https://codecept.io/locators#custom-locators
 
-[4]: /basics/#pause
+[4]: https://www.npmjs.com/package/faker
+
+[5]: https://raw.githubusercontent.com/Marak/faker.js/master/logo.png
+
+[6]: /basics/#pause
 
-[5]: https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage
+[7]: https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage
 
-[6]: https://github.com/istanbuljs/puppeteer-to-istanbul
+[8]: https://github.com/istanbuljs/puppeteer-to-istanbul
 
-[7]: https://github.com/gotwarlost/istanbul
+[9]: https://github.com/gotwarlost/istanbul
 
-[8]: https://aerokube.com/selenoid/
+[10]: https://aerokube.com/selenoid/
 
-[9]: https://aerokube.com/cm/latest/
+[11]: https://aerokube.com/cm/latest/
 
-[10]: https://hub.docker.com/u/selenoid
+[12]: https://hub.docker.com/u/selenoid
 
-[11]: https://aerokube.com/selenoid/latest/#_prepare_configuration
+[13]: https://aerokube.com/selenoid/latest/#_prepare_configuration
 
-[12]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container
+[14]: https://aerokube.com/selenoid/latest/#_option_2_start_selenoid_container
 
-[13]: https://docs.docker.com/engine/reference/commandline/create/
+[15]: https://docs.docker.com/engine/reference/commandline/create/
 
-[14]: https://codecept.io/img/codeceptjs-slideshow.gif
+[16]: https://codecept.io/img/codeceptjs-slideshow.gif
 
-[15]: https://webdriver.io
+[17]: https://webdriver.io
 
-[16]: https://webdriver.io/docs/selenium-standalone-service.html
+[18]: https://webdriver.io/docs/selenium-standalone-service.html
 
-[17]: https://webdriver.io/docs/sauce-service.html
+[19]: https://webdriver.io/docs/sauce-service.html

package/docs/reports.md

@@ -352,17 +352,18 @@ Configure mocha-multi with reports that you want:
         }
       },
       "mochawesome": {
-       "stdout": "./output/console.log",
-       "options": {
-         "reportDir": "./output",
-         "reportFilename": "report"
+        "stdout": "./output/console.log",
+        "options": {
+          "reportDir": "./output",
+          "reportFilename": "report"
+        }
       },
       "mocha-junit-reporter": {
         "stdout": "./output/console.log",
         "options": {
-          "mochaFile": "./output/result.xml"
-        },
-        "attachments": true //add screenshot for a failed test
+          "mochaFile": "./output/result.xml",
+          "attachments": true //add screenshot for a failed test
+        }
       }
     }
   }

package/docs/typescript.md

@@ -19,10 +19,10 @@ Example:
 
 ![Quick Info](/img/Quick_info.gif)
 
-- Checks types - thanks to TypeScript support in CodeceptJS now allow to tests your tests. TypeScript can prevent some errors: 
+- Checks types - thanks to TypeScript support in CodeceptJS now allow to tests your tests. TypeScript can prevent some errors:
   - invalid type of variables passed to function;
   - calls no-exist method from PageObject or `I` object;
-  - incorrectly used CodeceptJS features; 
+  - incorrectly used CodeceptJS features;
 
 
 ## Getting Started
@@ -106,7 +106,7 @@ declare namespace CodeceptJS {
 
 ## Types for custom helper or page object
 
-If you want to get types for your [custom helper](https://codecept.io/helpers/#configuration), you can add their automatically with CodeceptJS command `npx codeceptjs def`. 
+If you want to get types for your [custom helper](https://codecept.io/helpers/#configuration), you can add their automatically with CodeceptJS command `npx codeceptjs def`.
 
 For example, if you add the new step `printMessage` for your custom helper like this:
 ```js
@@ -121,9 +121,9 @@ export = CustomHelper
 ```
 
 Then you need to add this helper to your `codecept.conf.js` like in this [docs](https://codecept.io/helpers/#configuration).
-And then run the command `npx codeceptjs def`. 
+And then run the command `npx codeceptjs def`.
 
-As result our `steps.d.ts` file will be updated like this: 
+As result our `steps.d.ts` file will be updated like this:
 ```ts
 /// <reference types='codeceptjs' />
 type CustomHelper = import('./CustomHelper');
@@ -156,3 +156,45 @@ declare namespace CodeceptJS {
   }
 }
 ```
+
+## Types for custom strict locators
+
+You can define [custom strict locators](https://codecept.io/locators/#custom-strict-locators) that can be used in all methods taking a locator (parameter type `LocatorOrString`).
+
+Example: A custom strict locator with a `data` property, which can be used like this:
+
+```ts
+I.click({ data: 'user-login' });
+```
+
+In order to use the custom locator in TypeScript code, its type shape needs to be registered in the interface `CustomLocators` in your `steps.d.ts` file:
+
+```ts
+/// <reference types='codeceptjs' />
+...
+
+declare namespace CodeceptJS {
+  ...
+
+  interface CustomLocators {
+    data: { data: string };
+  }
+}
+```
+
+The property keys used in the `CustomLocators` interface do not matter (only the *types* of the interface properties are used). For simplicity it is recommended to use the name that is also used in your custom locator itself.
+
+You can also define more complicated custom locators with multiple (also optional) properties:
+
+```ts
+/// <reference types='codeceptjs' />
+...
+
+declare namespace CodeceptJS {
+  ...
+
+  interface CustomLocators {
+    data: { data: string, value?: number, flag?: boolean };
+  }
+}
+```

package/docs/webapi/fillField.mustache

@@ -12,4 +12,4 @@ I.fillField('form#login input[name=username]', 'John');
 I.fillField({css: 'form#login input[name=username]'}, 'John');
 ```
 @param {CodeceptJS.LocatorOrString} field located by label|name|CSS|XPath|strict locator.
-@param {string} value text value to fill.
+@param {CodeceptJS.StringOrSecret} value text value to fill.