docs: update Testing Types docs to use non-deprecated expect-type API and add toMatchObjectType documentation#8397
Merged
sheremet-va merged 4 commits intomainfrom Aug 9, 2025
Merged
Conversation
✅ Deploy Preview for vitest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…chTypeOf Co-authored-by: sheremet-va <[email protected]>
Copilot
AI
changed the title
[WIP] Update Testing Types docs to use non-deprecated API
docs: update Testing Types docs to use non-deprecated expect-type API
Aug 6, 2025
sheremet-va
approved these changes
Aug 6, 2025
Contributor
|
Could you also add documentation to ## toMatchObjectType
- **Type:** `<T>() => void`
This matcher performs a strict check on object types, ensuring that the expected type matches the provided object type. It's stricter than [`toExtend`](#toextend) and is the recommended choice when working with object types as it's more likely to catch issues like readonly properties.
```ts
import { expectTypeOf } from 'vitest'
expectTypeOf({ a: 1, b: 2 }).toMatchObjectType<{ a: number }>() // preferred
expectTypeOf({ a: 1, b: 2 }).toExtend<{ a: number }>() // works but less strict
// Supports nested object checking
const user = {
name: 'John',
address: { city: 'New York', zip: '10001' }
}
expectTypeOf(user).toMatchObjectType<{ name: string; address: { city: string } }>()
```
::: warning
This matcher only works with plain object types. It will fail for union types and other complex types. For those cases, use [`toExtend`](#toextend) instead.
::: |
Member
|
@copilot add documentation to ## toMatchObjectType
- **Type:** `<T>() => void`
This matcher performs a strict check on object types, ensuring that the expected type matches the provided object type. It's stricter than [`toExtend`](#toextend) and is the recommended choice when working with object types as it's more likely to catch issues like readonly properties.
```ts
import { expectTypeOf } from 'vitest'
expectTypeOf({ a: 1, b: 2 }).toMatchObjectType<{ a: number }>() // preferred
expectTypeOf({ a: 1, b: 2 }).toExtend<{ a: number }>() // works but less strict
// Supports nested object checking
const user = {
name: 'John',
address: { city: 'New York', zip: '10001' }
}
expectTypeOf(user).toMatchObjectType<{ name: string; address: { city: string } }>()
```
::: warning
This matcher only works with plain object types. It will fail for union types and other complex types. For those cases, use [`toExtend`](#toextend) instead.
::: |
Co-authored-by: sheremet-va <[email protected]>
Contributor
Author
... Added the |
Copilot
AI
changed the title
docs: update Testing Types docs to use non-deprecated expect-type API
docs: update Testing Types docs to use non-deprecated expect-type API and add toMatchObjectType documentation
Aug 7, 2025
sheremet-va
approved these changes
Aug 7, 2025
outslept
approved these changes
Aug 7, 2025
Contributor
Contributor
|
Looks good to me - thanks! |
sheremet-va
approved these changes
Aug 9, 2025
sheremet-va
requested changes
Aug 9, 2025
docs/api/expect-typeof.md
Outdated
| import { expectTypeOf } from 'vitest' | ||
|
|
||
| expectTypeOf({ a: 1, b: 2 }).toMatchObjectType<{ a: number }>() // preferred | ||
| expectTypeOf({ a: 1, b: 2 }).toExtend<{ a: number }>() // works but less strict |
Co-authored-by: sheremet-va <[email protected]>
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Testing Types documentation was using the deprecated
toMatchTypeOfmatcher from expect-type, which has been deprecated since v1.2.0 in favor oftoExtend. This PR updates all documentation to use the current API and adds comprehensive documentation fortoMatchObjectType.Changes Made
Updated deprecated API usage:
toMatchTypeOfwithtoExtendin code examples across/docs/guide/testing-types.mdand/docs/guide/features.mdtoMatchTypeOfdocumentation with clear migration guidance/test/config/test/config-types.test-d.tsto use current APIAdded new documentation:
toExtendsection with examples and usage patternstoMatchObjectTypesection with detailed documentation, examples, and usage guidelinestoExtendandtoMatchObjectTypeshowing when to use eachAPI Changes Documented
Before:
After:
The
toMatchObjectTypematcher provides stricter checking for object types and is recommended when working with plain objects as it's more likely to catch issues like readonly properties. For union types and complex types,toExtendshould be used instead.Fixes #8387.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.