Class ScenarioConfig

lib/mocha/scenarioConfig.js:5–137

@class

/** @class */
class ScenarioConfig {
  /**
   * @param {CodeceptJS.Test} test
   */
  constructor(test) {
    this.test = test
  }

  /**
   * Declares that test throws error.
   * Can pass an Error object or regex matching expected message.
   *
   * @param {*} err
   * @returns {this}
   */
  throws(err) {
    this.test.throws = err
    return this
  }

  /**
   * Declares that test should fail.
   * If test passes - throws an error.
   * Can pass an Error object or regex matching expected message.
   *
   * @returns {this}
   */
  fails() {
    this.test.throws = new Error()
    return this
  }

  /**
   * Retry this test for x times
   *
   * @param {number} retries
   * @returns {this}
   */
  retry(retries) {
    if (store.scenarioOnly) retries = -retries
    this.test.retries(retries)
    return this
  }

  /**
   * Set metadata for this test
   * @param {string} key
   * @param {string} value
   * @returns {this}
   */
  meta(key, value) {
    this.test.meta[key] = value
    return this
  }

  /**
   * Set timeout for this test
   * @param {number} timeout