archive-gh-me/vitest
1
0
Fork 0
mirror of https://github.com/vitest-dev/vitest.git synced 2026-02-01 17:36:51 +00:00
Code Issues Projects Releases Wiki Activity

docs: add chaiConfig note (#3144)

Browse Source 
Co-authored-by: Vladimir Sheremet <sleuths.slews0s@icloud.com>
This commit is contained in:
btea 2023-04-06 21:52:09 +08:00 committed by GitHub
parent 6fcba9ba16
commit c51433d074
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/expect.md
View File

@ -498,6 +498,10 @@ type Awaitable<T> = T | PromiseLike<T>
})
```
::: tip
If the value in the error message is too truncated, you can increase [chaiConfig.truncateThreshold](/config/#chaiconfig-truncatethreshold) in your config file.
:::
## toMatchObject
- **Type:** `(received: object | array) => Awaitable<void>`

4
docs/api/index.md
View File

@ -284,6 +284,10 @@ You cannot use this syntax, when using Vitest as [type checker](/guide/testing-t
If you want to have access to `TestContext`, use `describe.each` with a single test.
::: tip
Vitest processes `$values` with chai `format` method. If the value is too truncated, you can increase [chaiConfig.truncateThreshold](/config/#chaiconfig-truncatethreshold) in your config file.
:::
::: warning
You cannot use this syntax, when using Vitest as [type checker](/guide/testing-types).
:::