Skip to content

docs(custom_matchers): clarify match interfaces difference #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 28, 2025
Merged

docs(custom_matchers): clarify match interfaces difference #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
117f04d
docs(custom_matchers): make it clear the difference between match int…
oiagorodrigues Aug 28, 2025
257fe15
Update custom_matchers new interface
oiagorodrigues Aug 28, 2025
cc4181c
03/01: polish the `Matchers` explanation
kettanaito Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions exercises/03.assertions/01.solution.custom-matchers/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,11 @@ interface CustomMatchers<MatcherResult = any> {
}

declare module 'vitest' {
interface Assertion<T = any> extends CustomMatchers<T> {}
interface MatchersDeclaration extends CustomMatchers {}
interface Matchers<T> extends CustomMatchers<T> {}
}
```

There are two interfaces from `vitest` that I extend using module augmentgation:

- `Assertion<T>`, which controls the matchers returned by calling `expect()`;
- `MatchersDeclaration`, which annotates the matcher declarations passed to `expect.extend()`.
Here, I'm augmenting the `Matchers` type from `vitest` with my custom `CustomMatchers` type. By doing so, I'm extending the type definitions for the `expect()` function as well as the argument type of `expect.extend()` for later.

This is enough for the `.toMatchSchema()` custom matcher to be recognized by TypeScript:

Expand Down
Loading