JamieMason / JamieMason/expect-more

Document asymmetric matching capabilities

Open
#58 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
172
Forks
9
PR merge metrics
No merged PRs in 30d

Description

## Description

This library is very good. However the documentation doesn't mention that the matchers are also asymmetric. I had to test this by doing:

```js
expect([{ dt: new Date('2021-08-29') }]).toBeArrayOf({ dt:
expect.toBeDateInMonth(7)
});
```
It'd be nice if this was mentioned as this is one of the best things about this lib.

Also document that this works with Vitest

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the library's matcher documentation and the section covering toBeArrayOf and expect.toBeDateInMonth. Document asymmetric matching using the example in the issue, and note Vitest compatibility; done when both points are discoverable in the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.