Skip to content

Expect

ExpectHelper

Section titled “ExpectHelper”

This helper allows performing assertions based on Chai.

Examples

Section titled “Examples”

Zero-configuration when paired with other helpers like REST, Playwright:

// inside codecept.conf.js
{
  helpers: {
    Playwright: {...},
    Expect: {},
  }
}

Methods

Section titled “Methods”

expectAbove

Section titled “expectAbove”

Parameters

Section titled “Parameters”
  • targetData any
  • aboveThan any
  • customErrorMsg any?

expectBelow

Section titled “expectBelow”

Parameters

Section titled “Parameters”
  • targetData any
  • belowThan any
  • customErrorMsg any?

expectContain

Section titled “expectContain”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValueToContain any
  • customErrorMsg any?

expectDeepEqual

Section titled “expectDeepEqual”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • customErrorMsg any?

expectDeepEqualExcluding

Section titled “expectDeepEqualExcluding”

expects members of two JSON objects are deeply equal excluding some properties

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • fieldsToExclude any
  • customErrorMsg any?

expectDeepIncludeMembers

Section titled “expectDeepIncludeMembers”

expects an array to be a superset of another array

Parameters

Section titled “Parameters”
  • superset any
  • set any
  • customErrorMsg any?

expectDeepMembers

Section titled “expectDeepMembers”

expects members of two arrays are deeply equal

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • customErrorMsg any?

expectEmpty

Section titled “expectEmpty”

Parameters

Section titled “Parameters”
  • targetData any
  • customErrorMsg any?

expectEndsWith

Section titled “expectEndsWith”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValueToEndWith any
  • customErrorMsg any?

expectEqual

Section titled “expectEqual”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • customErrorMsg any?

expectEqualIgnoreCase

Section titled “expectEqualIgnoreCase”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • customErrorMsg any?

expectFalse

Section titled “expectFalse”

Parameters

Section titled “Parameters”
  • targetData any
  • customErrorMsg any?

expectHasAProperty

Section titled “expectHasAProperty”

Parameters

Section titled “Parameters”
  • targetData any
  • propertyName any
  • customErrorMsg any?

expectHasProperty

Section titled “expectHasProperty”

Parameters

Section titled “Parameters”
  • targetData any
  • propertyName any
  • customErrorMsg any?

expectJsonSchema

Section titled “expectJsonSchema”

Parameters

Section titled “Parameters”
  • targetData any
  • jsonSchema any
  • customErrorMsg any?

expectJsonSchemaUsingAJV

Section titled “expectJsonSchemaUsingAJV”

Parameters

Section titled “Parameters”
  • targetData any
  • jsonSchema any
  • customErrorMsg any?
  • ajvOptions any? Pass AJV options

expectLengthAboveThan

Section titled “expectLengthAboveThan”

Parameters

Section titled “Parameters”
  • targetData any
  • lengthAboveThan any
  • customErrorMsg any?

expectLengthBelowThan

Section titled “expectLengthBelowThan”

Parameters

Section titled “Parameters”
  • targetData any
  • lengthBelowThan any
  • customErrorMsg any?

expectLengthOf

Section titled “expectLengthOf”

Parameters

Section titled “Parameters”
  • targetData any
  • length any
  • customErrorMsg any?

expectMatchesPattern

Section titled “expectMatchesPattern”

expects a JSON object matches a provided pattern

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedPattern any
  • customErrorMsg any?

expectMatchRegex

Section titled “expectMatchRegex”

Parameters

Section titled “Parameters”
  • targetData any
  • regex any
  • customErrorMsg any?

expectNotContain

Section titled “expectNotContain”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValueToNotContain any
  • customErrorMsg any?

expectNotDeepEqual

Section titled “expectNotDeepEqual”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • customErrorMsg any?

expectNotEndsWith

Section titled “expectNotEndsWith”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValueToNotEndWith any
  • customErrorMsg any?

expectNotEqual

Section titled “expectNotEqual”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValue any
  • customErrorMsg any?

expectNotStartsWith

Section titled “expectNotStartsWith”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValueToNotStartWith any
  • customErrorMsg any?

expectStartsWith

Section titled “expectStartsWith”

Parameters

Section titled “Parameters”
  • actualValue any
  • expectedValueToStartWith any
  • customErrorMsg any?

expectToBeA

Section titled “expectToBeA”

Parameters

Section titled “Parameters”
  • targetData any
  • type any
  • customErrorMsg any?

expectToBeAn

Section titled “expectToBeAn”

Parameters

Section titled “Parameters”
  • targetData any
  • type any
  • customErrorMsg any?

expectTrue

Section titled “expectTrue”

Parameters

Section titled “Parameters”
  • targetData any
  • customErrorMsg any?