Skip to content

docs: Fix mock call assertion in documentation #8836

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

Closed
wants to merge 2 commits into from
Closed

docs: Fix mock call assertion in documentation #8836

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ed39f2
Fix mock call assertion in documentation
danielrentz Oct 27, 2025
bac371e
Merge branch 'vitest-dev:main' into patch-1
danielrentz Nov 4, 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
2 changes: 1 addition & 1 deletion docs/api/mock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { vi } from 'vitest'

const fn = vi.fn()
fn('hello world')
fn.mock.calls[0] === ['hello world']
fn.mock.calls[0][0] === 'hello world'
Copy link
Member

@sheremet-va sheremet-va Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's important to show the array. If this is a confusing representation, I propose

Suggested change
fn.mock.calls[0][0] === 'hello world'
fn.mock.calls[0] // == ['hello world']

Copy link
Contributor Author

@danielrentz danielrentz Oct 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sheremet-va Yeah this is done throughout the documentation (as I have seen after creating the PR), especially on the Mocks page.
I think it is better to use your proposed style with a comment to not advertise to use this in real tests. I will extend the PR to cover all other places when I am back from vacation :)

Copy link
Contributor Author

@danielrentz danielrentz Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sheremet-va I think the best way would be to change these examples to use real expect assertions:

epect(fn.mock.calls[0]).toEqual(['hello world'])

as done in most other examples in the documentation. If you agree, I would adapt similar examples in the docs as well.

Copy link
Member

@sheremet-va sheremet-va Nov 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't want to introduce different concepts in this part of the guide, like assertions

Copy link
Contributor Author

@danielrentz danielrentz Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, then I would say it's best to leave it as it is.


const market = {
getApples: () => 100
Expand Down