# loadero-nightwatch-commands > Loadero custom commands that can be used when localy developing tests to use with Loadero Latest version **1.1.0** (published 2023-12-14) · ISC license · 0 weekly downloads ## Install ```sh npm install loadero-nightwatch-commands pnpm add loadero-nightwatch-commands yarn add loadero-nightwatch-commands bun add loadero-nightwatch-commands ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2023-12-14 | | First published | 2023-07-20 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 50.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Loadero | | Maintainers | loadero-dev | ## Links - npm: https://www.npmjs.com/package/loadero-nightwatch-commands - Repository: https://github.com/loadero/loadero-nightwatch-commands - Homepage: https://github.com/loadero/loadero-nightwatch-commands#readme - Issues: https://github.com/loadero/loadero-nightwatch-commands/issues - npm.io page: https://npm.io/package/loadero-nightwatch-commands ## Recent versions - 1.1.0 (latest) — 2023-12-14 - 1.0.0 — 2023-07-20 ## README # loadero-nightwatch-commands [![npm](https://img.shields.io/npm/v/loadero-nightwatch-commands)](https://www.npmjs.com/package/loadero-nightwatch-commands) ## Installation Installation is as simple as running the following npm command: ```bash npm install --save loadero-nightwatch-commands ``` Make sure you run it in the directory where your `package.json` file is located. The command shown above will also add the dependency to your `package.json` file. It can also be added manually in `dependencies` object as `loadero-nightwatch-commands`. The latest tag will always be the most up-to-date version when compared to the commands used in Loadero environment. ## Usage These Nightwatch custom commands were made to simplify local script development for usage in Loadero environment. By using these commands, you can write your Loadero script locally and then upload it to Loadero. This also allows for more rapid development because the script can be debugged and run locally. To use the commands in your tests, you need to add this package as a plugin to your Nightwatch configuration file. For example, if your project has a `nightwatch.conf.js` file, you need to add the following line to it: ```javascript plugins: ["loadero-nightwatch-commands"] ``` After that, all you have to do then is run `npm install` after which you will be able to use the commands in your tests. For example: ```javascript client => { const reallyLongPause = 5 * 60 * 1000; // 5 minutes client // Example of timing execution without specifying a timeout. .url("https://duckduckgo.com/") .timeExecution("locate_search_bar", () => { client .waitForElementVisible("#searchbox_input", 10 * 1000) .sendKeys("#searchbox_input", "QA Processes") .click("[aria-label='Search']") .waitForElementVisible("#r1-0 > div > h2", 10 * 1000) .pause(reallyLongPause); }) .takeScreenshot("screenshot.png"); } ``` > **_NOTE:_** In place of `client` you should use the argument that describes > the nightwatch client in your test. By default Loadero creates the template > using `client`. A lot of times `client` is also referred to as `browser`. Not all commands behave the same way as they do in the Loadero environment. Some of them are modified to work in a local environment, such as `updateNetwork` and `setRequestHeader`. ## Commands The following table shows all available commands and whether there are any changes to how they function in a local environment. Full descriptions for how each function behaves in Loadero and their usage can be found in [Loadero wiki](https://wiki.loadero.com/docs/nightwatch/custom-commands/) page. To see the differences between local and Loadero environment, you can compare the descriptions in the wiki to the differences mentioned in this README. | Command | Differences | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `genEmail` | Full email or only first part can be provided, if only the first part is provided then `@mailinator.com` is appended | | `ignoreAlert` | No differences | | `performTimed` | No differences | | `receiveEmail` | By default an empty array will be returned, but `emails.json` file can be saved in the working directory which will contain all of the emails | | `setFile` | Any local file can be used, migration to Loadero may require changing the file path | | `setRequestHeader` | No request header will be set | | `setUserAgent` | User agent won't be changed | | `takeScreenshot` | Screenshot will be saved locally in project root directory | | `timeExecution` | Execution time will be logged, but not saved | | `updateNetwork` | Network settings will not be updated | | `waitForDownloadFinished` | Function will finish instantly and not wait for download to be finished | The `emails.json` file should be located in the same directory where `package.json` file is located in your project and should have the following structure: ```json { "emails": [ { "from": "email_from", "to": "email_to", "headers": { "header1": "header_value" }, "subject": "email_subject", "text/html": "html body", "text/plain": "plain text body" } ] } ``` To simulate a more realistic environment, you can modify the `emails.json` file mid-run to add additional emails to the array. The file will be read every time the `receiveEmail` command is called. --- _Source: https://npm.io/package/loadero-nightwatch-commands · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._