Correcting mockClear api docs

[Biki-das]

Documentation page:
https://jestjs.io/docs/mock-function-api#mockfnmockclear

Summary

mock.mockClear() and clearMocks:true are reseting ``mock.calls,mock.instances and `mock.results` of a mock function not only the first two ones that doc say

module.exports = {
   clearMocks: false,
   resetMocks: false
}```

```const mock = jest.fn(x => x * 2);

beforeEach(() => {
   mock.mockClear()
})

it('test1', () => {
   mock(2);
   mock(3);
   console.log(mock.mock.calls, mock.mock.instances, mock.mock.results);
   // [ [ 2 ], [ 3 ] ]
   // [ undefined, undefined ]
   // [ { type: 'return', value: 4 }, { type: 'return', value: 6 } ]
});

it('test2', () => {
   console.log(mock.mock.calls, mock.mock.instances, mock.mock.results);
   // [] [] []
});

Removing beforeEach() and toggling clearMocks config option won't affect the result

[Biki-das]

@SimenB please review

[mrazauskas]

@Biki-das It makes sense.

Could you add mock.results to the documentation of jest.clearAllMocks() as well – https://jestjs.io/docs/jest-object#jestclearallmocks

[Biki-das]

@Biki-das It makes sense.

Could you add mock.results to the documentation of jest.clearAllMocks() as well – https://jestjs.io/docs/jest-object#jestclearallmocks

i am kinds confused where should i add it

[mrazauskas]

Oh, sorry.

Right now it states: "Clears the mock.calls and mock.instances properties of all mocks."
Seems like it should be: "Clears the mock.calls, mock.instances and mock.results properties of all mocks."

Or I mixed up something?

[codecov-commenter]

Codecov Report

Merging #12019 (3882238) into main (10d9580) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main   #12019   +/-   ##
=======================================
  Coverage   68.77%   68.77%           
=======================================
  Files         324      324           
  Lines       16669    16669           
  Branches     4813     4813           
=======================================
  Hits        11464    11464           
  Misses       5172     5172           
  Partials       33       33           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 10d9580...3882238. Read the comment docs.

[Biki-das]

/review @SimenB

[SimenB]

thanks!

[SimenB]

Prettier is unhappy, could you run yarn lint:prettier locally?

[Biki-das]

Prettier is unhappy, could you run yarn lint:prettier locally?

sure

[Biki-das]

@SimenB i want to thank you , you are really a nice person to work with,😊😊

[Biki-das]

@SimenB sorry for the issue! Hope it's fine now

[SimenB]

perfect, thanks again!

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.