docs(jest-matcher-utils): README.md (#11942)

jestjs · Oct 9, 2021 · 03f4a69 · 03f4a69
1 parent dd859ac
commit 03f4a69
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/packages/jest-matcher-utils/README.md b/packages/jest-matcher-utils/README.md
@@ -0,0 +1,24 @@
+# jest-matcher-utils
+
+This package's exports are most notably used by `expect`'s [`this.utils`](https://jestjs.io/docs/expect#thisutils).
+
+## Installation
+
+To add this package as a dependency of a project, run either of the following commands:
+
+- `npm install jest-matcher-utils`
+- `yarn add jest-matcher-utils`
+
+## Exports ([src/index.ts](jest-matcher-utils/src/index.ts))
+
+### Functions
+
+`stringify` `highlightTrailingWhitespace` `printReceived` `printExpected` `printWithType` `ensureNoExpected` `ensureActualIsNumber` `ensureExpectedIsNumber` `ensureNumbers` `ensureExpectedIsNonNegativeInteger` `printDiffOrStringify` `diff` `pluralize` `getLabelPrinter` `matcherErrorMessage` `matcherHint`
+
+### Types
+
+`MatcherHintOptions` `DiffOptions`
+
+### Constants
+
+`EXPECTED_COLOR` `RECEIVED_COLOR` `INVERTED_COLOR` `BOLD_WEIGHT` `DIM_COLOR` `SUGGEST_TO_CONTAIN_EQUAL`