Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 22, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d36fb71
fix: expect helper to have custom error message as optional param
kobenguyent Dec 18, 2023
a58cc16
fix: expect helper to have custom error message as optional param
kobenguyent Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions docs/helpers/Expect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -78,7 +78,7 @@ expects an array to be a superset of another array

- `superset` **any**
- `set` **any**
- `customErrorMsg` **any**
- `customErrorMsg` **any?**

### expectDeepMembers

Expand All @@ -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
Expand All @@ -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

Expand All @@ -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?**
Loading