| 1 | # jest-matcher-utils
|
| 2 |
|
| 3 | This package's exports are most notably used by `expect`'s [`this.utils`](https://jestjs.io/docs/expect#thisutils).
|
| 4 |
|
| 5 | ## Installation
|
| 6 |
|
| 7 | To add this package as a dependency of a project, run either of the following commands:
|
| 8 |
|
| 9 | - `npm install jest-matcher-utils`
|
| 10 | - `yarn add jest-matcher-utils`
|
| 11 |
|
| 12 | ## Exports ([src/index.ts](jest-matcher-utils/src/index.ts))
|
| 13 |
|
| 14 | ### Functions
|
| 15 |
|
| 16 | `stringify` `highlightTrailingWhitespace` `printReceived` `printExpected` `printWithType` `ensureNoExpected` `ensureActualIsNumber` `ensureExpectedIsNumber` `ensureNumbers` `ensureExpectedIsNonNegativeInteger` `printDiffOrStringify` `diff` `pluralize` `getLabelPrinter` `matcherErrorMessage` `matcherHint`
|
| 17 |
|
| 18 | ### Types
|
| 19 |
|
| 20 | `MatcherHintOptions` `DiffOptions`
|
| 21 |
|
| 22 | ### Constants
|
| 23 |
|
| 24 | `EXPECTED_COLOR` `RECEIVED_COLOR` `INVERTED_COLOR` `BOLD_WEIGHT` `DIM_COLOR` `SUGGEST_TO_CONTAIN_EQUAL`
|