aboutsummaryrefslogtreecommitdiff
path: root/node_modules/jest-matcher-utils/README.md
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/jest-matcher-utils/README.md
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/jest-matcher-utils/README.md')
-rw-r--r--node_modules/jest-matcher-utils/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/node_modules/jest-matcher-utils/README.md b/node_modules/jest-matcher-utils/README.md
new file mode 100644
index 0000000..d3e9d13
--- /dev/null
+++ b/node_modules/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](https://github.com/facebook/jest/blob/HEAD/packages/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`