docs: add chaiConfig note (#3144)

Co-authored-by: Vladimir Sheremet <sleuths.slews0s@icloud.com>
vitest-dev · Apr 6, 2023 · c51433d · c51433d
1 parent 6fcba9b
commit c51433d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/api/expect.md b/docs/api/expect.md
@@ -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>`

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -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).
 :::