1
0
mirror of https://github.com/jbranchaud/til synced 2026-01-03 15:18:01 +00:00

Add Define A Custom Jest Matcher as a javascript til

This commit is contained in:
jbranchaud
2020-01-28 11:50:37 -06:00
parent 2fa329eced
commit ea4092b769
2 changed files with 48 additions and 1 deletions

View File

@@ -0,0 +1,46 @@
# Define A Custom Jest Matcher
Though [Jest's built-in
matchers](https://jestjs.io/docs/en/expect) will get you pretty
far in most testing scenarios, you may find yourself in a testing situation
better served by a custom matcher. Custom matchers can be defined using the
[`expect.extend()`
function](https://jestjs.io/docs/en/expect#expectextendmatchers).
Here is an example of a matcher that can check equality of two objects based
solely on their `id` property.
```javascript
expect.extend({
toHaveMatchingId(recieved, expected) {
const pass = recieved.id === expected.id;
if (pass) {
return {
pass: true,
message: `Actual ${recieved.id} matches expected ${expected.id}`
};
} else {
return {
pass: false,
message: `Actual ${recieved.id} does not match expected ${expected.id}`
};
}
}
});
```
This defines the name of the matcher (`toHaveMatchingId`), contains some logic
to figure out whether `received` and `expected` pass the matcher, and then two
return conditions (`pass: true` and `pass: false`) with accompanying messages.
It can then be used like any other Jest matcher:
```javascript
test("compare objects", () => {
expect({ id: "001" }).toHaveMatchingId({ id: "001" });
expect({ id: "001" }).toHaveMatchingId({ id: "002" });
});
```
Check out a [live example](https://codesandbox.io/s/focused-bush-vw2s5).