codeceptjs 2.3.4 → 2.4.1

package/docs/api/helper.md

@@ -1,116 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## Helper
-
-### Parameters
-
--   `config`  
-
-### \_after
-
-Hook executed after each test
-
-### \_afterStep
-
-Hook executed after each step
-
-#### Parameters
-
--   `step` **any** 
-
-### \_afterSuite
-
-Hook executed after each suite
-
-#### Parameters
-
--   `suite` **any** 
-
-### \_before
-
-Hook executed before each test.
-
-### \_beforeStep
-
-Hook executed before each step
-
-#### Parameters
-
--   `step` **any** 
-
-### \_beforeSuite
-
-Hook executed before each suite
-
-#### Parameters
-
--   `suite` **any** 
-
-### \_failed
-
-Hook executed after each failed test
-
-#### Parameters
-
--   `test` **any** 
-
-### \_finishTest
-
-Hook executed after all tests are executed
-
-#### Parameters
-
--   `suite` **any** 
-
-### \_init
-
-Hook executed before all tests
-
-### \_passed
-
-Hook executed after each passed test
-
-#### Parameters
-
--   `test` **any** 
-
-### \_setConfig
-
-Sets config for current test
-
-#### Parameters
-
--   `opts`  
-
-### \_test
-
-Hook provides a test details
-Executed in the very beginning of a test
-
-#### Parameters
-
--   `test` **any** 
-
-### \_validateConfig
-
-Abstract method to validate config
-
-#### Parameters
-
--   `config` **any** 
-
-### debug
-
-Print debug message to console (outputs only in debug mode)
-
-#### Parameters
-
--   `msg`  
-
-### helpers
-
-Access another configured helper: `this.helpers['AnotherHelper']`
-
-### \_config
-
-Abstract method to provide required config options

package/docs/api/output.md

@@ -1,67 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## debug
-
-Print information in --debug mode
-
-### Parameters
-
--   `msg`  
-
-## error
-
-Print error
-
-### Parameters
-
--   `msg`  
-
-## level
-
-Set or return current verbosity level
-
-### Parameters
-
--   `level`  
-
-## log
-
-Print information in --verbose mode
-
-### Parameters
-
--   `msg`  
-
-## process
-
-Print information for a process
-Used in multiple-run
-
-### Parameters
-
--   `process`  
-
-## say
-
-Print a text in console log
-
-### Parameters
-
--   `message`  
--   `color`   (optional, default `'cyan'`)
-
-## step
-
-Print a step
-
-### Parameters
-
--   `step`  
-
-## success
-
-Print a successful message
-
-### Parameters
-
--   `msg`  

package/docs/api/recorder.md

@@ -1,63 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## recorder
-
-Singleton object to record all test steps as promises and run them in chain.
-
-### add
-
-Adds a promise to a chain.
-Promise description should be passed as first parameter.
-
-#### Parameters
-
--   `taskName` **any** 
--   `fn` **any**  (optional, default `undefined`)
--   `force` **any**  (optional, default `false`)
--   `retry` **[boolean][1]**     true: it will retries if `retryOpts` set.
-        false: ignore `retryOpts` and won't retry. (optional, default `true`)
-
-### errHandler
-
-Add error handler to catch rejected promises
-
-#### Parameters
-
--   `fn` **any** 
-
-### promise
-
-Get latest promise in chain.
-
-### reset
-
-Stops current promise chain, calls `catch`.
-Resets recorder to initial state.
-
-### retries
-
-### scheduled
-
-Get a list of all chained tasks
-
-### start
-
-Start recording promises
-
-### stop
-
-Stops recording promises
-
-### throw
-
-Adds a promise which throws an error into a chain
-
-#### Parameters
-
--   `err` **any** 
-
-### toString
-
-Get a state of current queue and tasks
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

package/docs/helpers/SeleniumWebdriver.md

@@ -1,92 +0,0 @@
----
-id: SeleniumWebdriver
-title: SeleniumWebdriver
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## SeleniumWebdriver
-
-Extends Helper
-
-SeleniumWebdriver helper is based on the official [Selenium Webdriver JS][1]
-library. It implements common web api methods (amOnPage, click, see).
-
-## Backends
-
-### Selenium Installation
-
-1.  Download [Selenium Server][2]
-2.  For Chrome browser install [ChromeDriver][3], for Firefox browser install [GeckoDriver][4].
-3.  Launch the server: `java -jar selenium-server-standalone-3.xx.xxx.jar`. To locate Chromedriver binary use `-Dwebdriver.chrome.driver=./chromedriver` option. For Geckodriver use `-Dwebdriver.gecko.driver=`.
-
-### PhantomJS Installation
-
-PhantomJS is a headless alternative to Selenium Server that implements [the WebDriver protocol][5].
-It allows you to run Selenium tests on a server without a GUI installed.
-
-1.  Download [PhantomJS][6]
-2.  Run PhantomJS in WebDriver mode: `phantomjs --webdriver=4444`
-
-## Configuration
-
-This helper should be configured in codecept.json or codecept.conf.js
-
--   `url` - base url of website to be tested
--   `browser` - browser in which perform testing
--   `driver` - which protractor driver to use (local, direct, session, hosted, sauce, browserstack). By default set to 'hosted' which requires selenium server to be started.
--   `restart` - restart browser between tests (default: true).
--   `smartWait`: (optional) enables SmartWait; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000
--   `disableScreenshots`   - don't save screenshot on failure
--   `uniqueScreenshotNames`   - option to prevent screenshot override if you have scenarios with the same name in different suites
--   `keepBrowserState`   - keep browser state between tests when `restart` set to false.
--   `keepCookies`   - keep cookies between tests when `restart` set to false.\
--   `seleniumAddress` - Selenium address to connect (default: [http://localhost:4444/wd/hub][7])
--   `waitForTimeout`: (optional) sets default wait time in _ms_ for all `wait` functions. 1000 by default;
--   `scriptTimeout`: (optional) sets default timeout for scripts in `executeAsync`. 1000 by default.
--   `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
--   `manualStart`  - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriverIO"]._startBrowser()`
--   `capabilities`: {} - list of [Desired Capabilities][8]
-
-Example:
-
-```json
-{
-   "helpers": {
-     "SeleniumWebdriver" : {
-       "url": "http://localhost",
-       "browser": "chrome",
-       "smartWait": 5000,
-       "restart": false
-     }
-   }
-}
-```
-
-## Access From Helpers
-
-Receive a WebDriverIO client from a custom helper by accessing `browser` property:
-
-```js
-this.helpers['SeleniumWebdriver'].browser
-```
-
-### Parameters
-
--   `config`  
-
-[1]: https://www.npmjs.com/package/selenium-webdriver
-
-[2]: http://docs.seleniumhq.org/download/
-
-[3]: https://sites.google.com/a/chromium.org/chromedriver/getting-started
-
-[4]: https://github.com/mozilla/geckodriver
-
-[5]: https://code.google.com/p/selenium/wiki/JsonWireProtocol
-
-[6]: http://phantomjs.org/download.html
-
-[7]: http://localhost:4444/wd/hub
-
-[8]: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities