hermiona-helper

2.2.0 • Public • Published

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 hermiona-helper --save

Usage

Create CodeceptJS helper as described in documentation.

const Helper = require('hermiona-helper');

class MyHelper extends Helper {
  // implement custom helper here
}

API

Table of Contents

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? (optional, default null)

_after

Hook executed after each test

Parameters
  • test Mocha.Test? (optional, default null)

_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 HermionaJS.Step

_afterStep

Hook executed after each step

Parameters
  • step HermionaJS.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

debugSection

Parameters

_config

Abstract method to provide required config options

Returns any

Readme

Keywords

Package Sidebar

Install

npm i hermiona-helper

Weekly Downloads

0

Version

2.2.0

License

ISC

Unpacked Size

9.68 kB

Total Files

4

Last publish

Collaborators

  • zular