docs: optimizeDeps.needsInterop (#13323)

Co-authored-by: Bjorn Lu <34116392+bluwy@users.noreply.github.com>
This commit is contained in:
patak 2023-05-24 15:42:47 +02:00 committed by GitHub
parent 32c5a9a618
commit b34e79c616
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 1 deletions

View File

@ -65,3 +65,10 @@ Optimizing dependencies in build mode is **experimental**. If enabled, it remove
If you want to try this build strategy, you can use `optimizeDeps.disabled: false`. `@rollup/plugin-commonjs` can be removed by passing `build.commonjsOptions: { include: [] }`.
:::
## optimizeDeps.needsInterop
- **Experimental**
- **Type:** `string[]`
Forces ESM interop when importing these dependencies. Vite is able to properly detect when a dependency needs interop, so this option isn't generally needed. However, different combinations of dependencies could cause some of them to be prebundled differently. Adding these packages to `needsInterop` can speed up cold start by avoiding full-page reloads. You'll receive a warning if this is the case for one of your dependencies, suggesting to add the package name to this array in your config.

View File

@ -78,7 +78,7 @@ export interface DepOptimizationConfig {
*/
exclude?: string[]
/**
* Force ESM interop when importing for these dependencies. Some legacy
* Forces ESM interop when importing these dependencies. Some legacy
* packages advertise themselves as ESM but use `require` internally
* @experimental
*/