Skip to content

Commit

Permalink
fix: updated deprecated eachLike V3 description.
Browse files Browse the repository at this point in the history
Adapted `eachLike` V3 description as discussed in #1207
  • Loading branch information
timvahlbrock authored and Tim Vahlbrock committed Apr 17, 2024
1 parent f2d0788 commit 1e7b7ae
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/matching.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ const animalBodyExpectation = {
| Matcher | Parameters | Description |
| ---------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `like` | template | Applies the `type` matcher to value, which requires values to have the same type as the template |
| `eachLike` | template | Applies the `type` matcher to each value in an array, ensuring they match the template. Note that this matcher does not validate the length of the array, and the items within it |
| `eachLike` | template, min: number = 1 | | Applies the `type` matcher to each value in an array, ensuring they match the template. Note that this matcher does validate the length of the array to be at least one by default, as the contents of the array might otherwise never be matched. |
| `atLeastOneLike` | template, count: number = 1 | Behaves like the `eachLike` matcher, but also applies a minimum length validation of one on the length of the array. The optional `count` parameter controls the number of examples generated. |
| `atLeastLike` | template, min: number, count?: number | Just like `atLeastOneLike`, but the minimum length is configurable. |
| `atMostLike` | template, max: number, count?: number | Behaves like the `eachLike` matcher, but also applies a maximum length validation on the length of the array. The optional `count` parameter controls the number of examples generated. |
Expand Down

0 comments on commit 1e7b7ae

Please sign in to comment.