https://github.com/codeceptjs/helper
Base class for CodeceptJS helpers
https://github.com/codeceptjs/helper
Last synced: 2 months ago
JSON representation
Base class for CodeceptJS helpers
- Host: GitHub
- URL: https://github.com/codeceptjs/helper
- Owner: codeceptjs
- License: mit
- Created: 2020-09-21T22:25:21.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T10:36:19.000Z (almost 2 years ago)
- Last Synced: 2025-08-27T07:19:08.145Z (4 months ago)
- Language: TypeScript
- Size: 18.6 KB
- Stars: 1
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CodeceptJS Helper
Base class for all CodeceptJS helpers. This class has been moved into a separate package to allow other helpers to be extended from it, without requiring main codeceptjs package.
## Installation
npm i @codeceptjs/helper --save
## Usage
[Create CodeceptJS helper as described in documentation](https://codecept.io/helpers/).
```js
const Helper = require('@codeceptjs/helper');
class MyHelper extends Helper {
// implement custom helper here
}
```
## API
#### Table of Contents
- [Helper](#helper)
- [Parameters](#parameters)
- [\_validateConfig](#_validateconfig)
- [Parameters](#parameters-1)
- [\_setConfig](#_setconfig)
- [Parameters](#parameters-2)
- [\_init](#_init)
- [\_before](#_before)
- [Parameters](#parameters-3)
- [\_after](#_after)
- [\_test](#_test)
- [Parameters](#parameters-4)
- [\_passed](#_passed)
- [Parameters](#parameters-5)
- [\_failed](#_failed)
- [Parameters](#parameters-6)
- [\_beforeStep](#_beforestep)
- [Parameters](#parameters-7)
- [\_afterStep](#_afterstep)
- [Parameters](#parameters-8)
- [\_beforeSuite](#_beforesuite)
- [Parameters](#parameters-9)
- [\_afterSuite](#_aftersuite)
- [Parameters](#parameters-10)
- [\_finishTest](#_finishtest)
- [Parameters](#parameters-11)
- [\_useTo](#_useto)
- [Parameters](#parameters-12)
- [helpers](#helpers)
- [debug](#debug)
- [Parameters](#parameters-13)
- [debugSection](#debugsection)
- [Parameters](#parameters-14)
- [\_config](#_config)
### Helper
Abstract class.
Helpers abstracts test execution backends.
Methods of Helper class will be available in tests in `I` object.
They provide user-friendly abstracted actions over NodeJS libraries.
Hooks (methods starting with `_`) can be used to setup/teardown,
or handle execution flow.
Methods are expected to return a value in order to be wrapped in promise.
#### Parameters
- `config` **any**
#### \_validateConfig
Abstract method to validate config
##### Parameters
- `config` **any**
Returns **any**
#### \_setConfig
Sets config for current test
##### Parameters
- `opts` **any**
#### \_init
Hook executed before all tests
#### \_before
Hook executed before each test.
##### Parameters
- `test` **Mocha.Test**
#### \_after
Hook executed after each test
#### \_test
Hook provides a test details
Executed in the very beginning of a test
##### Parameters
- `test` **Mocha.Test**
#### \_passed
Hook executed after each passed test
##### Parameters
- `test` **Mocha.Test**
#### \_failed
Hook executed after each failed test
##### Parameters
- `test` **Mocha.Test**
#### \_beforeStep
Hook executed before each step
##### Parameters
- `step` **CodeceptJS.Step**
#### \_afterStep
Hook executed after each step
##### Parameters
- `step` **CodeceptJS.Step**
#### \_beforeSuite
Hook executed before each suite
##### Parameters
- `suite` **Mocha.Suite**
#### \_afterSuite
Hook executed after each suite
##### Parameters
- `suite` **Mocha.Suite**
#### \_finishTest
Hook executed after all tests are executed
##### Parameters
- `suite` **Mocha.Suite**
#### \_useTo
Abstract method to provide common interface to accessing helpers internals inside a test.
##### Parameters
- `description`
- `fn`
#### helpers
Access another configured helper: `this.helpers['AnotherHelper']`
Type: any
#### debug
Print debug message to console (outputs only in debug mode)
##### Parameters
- `msg` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
#### debugSection
##### Parameters
- `section` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
- `msg` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
#### \_config
Abstract method to provide required config options
Returns **any**