fix: expect helper to have custom error message as optional param (#4082

)
codeceptjs · Dec 22, 2023 · b4b6dd8 · b4b6dd8
1 parent 0341547
commit b4b6dd8
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 64 deletions.
diff --git a/docs/helpers/Expect.md b/docs/helpers/Expect.md
@@ -32,32 +32,32 @@ Zero-configuration when paired with other helpers like REST, Playwright:
 #### Parameters
 
 -   `targetData` **any** 
--   `aboveThan` **any** number | Date
--   `customErrorMsg` **any**  
+-   `aboveThan` **any** 
+-   `customErrorMsg` **any?**  
 
 ### expectBelow
 
 #### Parameters
 
 -   `targetData` **any** 
--   `belowThan` **any** number | Date
--   `customErrorMsg` **any**  
+-   `belowThan` **any** 
+-   `customErrorMsg` **any?**  
 
 ### expectContain
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValueToContain` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectDeepEqual
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectDeepEqualExcluding
 
@@ -68,7 +68,7 @@ expects members of two JSON objects are deeply equal excluding some properties
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
 -   `fieldsToExclude` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectDeepIncludeMembers
 
@@ -78,7 +78,7 @@ expects an array to be a superset of another array
 
 -   `superset` **any** 
 -   `set` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectDeepMembers
 
@@ -88,77 +88,77 @@ expects members of two arrays are deeply equal
 
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectEmpty
 
 #### Parameters
 
 -   `targetData` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectEndsWith
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValueToEndWith` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectEqual
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectEqualIgnoreCase
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectFalse
 
 #### Parameters
 
 -   `targetData` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectHasAProperty
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `propertyName` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectHasProperty
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `propertyName` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectJsonSchema
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `jsonSchema` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectJsonSchemaUsingAJV
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `jsonSchema` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 -   `ajvOptions` **any** Pass AJV options 
 
 ### expectLengthAboveThan
@@ -167,23 +167,23 @@ expects members of two arrays are deeply equal
 
 -   `targetData` **any** 
 -   `lengthAboveThan` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectLengthBelowThan
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `lengthBelowThan` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectLengthOf
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `length` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectMatchesPattern
 
@@ -193,83 +193,83 @@ expects a JSON object matches a provided pattern
 
 -   `actualValue` **any** 
 -   `expectedPattern` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectMatchRegex
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `regex` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectNotContain
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValueToNotContain` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectNotDeepEqual
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectNotEndsWith
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValueToNotEndWith` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectNotEqual
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValue` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectNotStartsWith
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValueToNotStartWith` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectStartsWith
 
 #### Parameters
 
 -   `actualValue` **any** 
 -   `expectedValueToStartWith` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectToBeA
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `type` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectToBeAn
 
 #### Parameters
 
 -   `targetData` **any** 
 -   `type` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**  
 
 ### expectTrue
 
 #### Parameters
 
 -   `targetData` **any** 
--   `customErrorMsg` **any**  
+-   `customErrorMsg` **any?**