[Docs] mockObject API the second params spy : true usage in documentation, Should we consider removing this section from the documentation?

[guoxk-me]

Description

Why hasn't the documentation about the mockObject { spy: true } option been removed, From what I understand in issue [#8284], this parameter is not exposed to end-users, I'm not sure if my confusion is because I haven't fully read the documentation.

为什么不删除掉文档中关于mockObject spy:true的部分,我看到issue [#8284] 中没有将此参数暴漏给用户，我不确定是不是我没有完整的看完文档导致。

EN: https://vitest.dev/api/vi.html#vi-mockobject-3-2-0
中文(CN): https://cn.vitest.dev/api/vi.html#vi-mockobject-3-2-0

[hi-ogawa]

I'm not sure what you mean. vi.mockObject(origin, { spy: true }) should work as documented.

[guoxk-me]

Sorry, I found the issue — I was using version 3.🤦‍♂️😭

[guoxk-me]

Sorry for the trouble — as a beginner with Vitest, I’ll be more careful in the future.This is really embarrassing.🥲

[guoxk-me]

But I think we should update the mockObject type in the documentation.

mockObject: <T>(value: T, options?: MockOptions) => MaybeMockedDeep<T>;

[hi-ogawa]

That's already happening :) #9215

[guoxk-me]

Thank you for your reply.