[READ-ONLY] Mirror of https://github.com/vitest-dev/vitest. Next generation testing framework powered by Vite.
vitest.dev
test
testing-tools
vite
docs: clarify the custom provider API is experimental (#7855)
+8
-8
+8
-8
docs/guide/browser/config.md
+8
-8
docs/guide/browser/config.md
···
110
110
- **Type:** `string`
111
111
- **CLI:** `--browser=safari`
112
112
113
-
::: danger
113
+
::: danger DEPRECATED
114
114
This API is deprecated an will be removed in Vitest 4. Please, use [`browser.instances`](#browser-instances) option instead.
115
115
:::
116
116
···
150
150
151
151
Configure options for Vite server that serves code in the browser. Does not affect [`test.api`](#api) option. By default, Vitest assigns port `63315` to avoid conflicts with the development server, allowing you to run both in parallel.
152
152
153
-
## browser.provider <Badge type="warning">experimental</Badge> {#browser-provider}
153
+
## browser.provider {#browser-provider}
154
154
155
155
- **Type:** `'webdriverio' | 'playwright' | 'preview' | string`
156
156
- **Default:** `'preview'`
157
157
- **CLI:** `--browser.provider=playwright`
158
-
159
-
::: danger ADVANCED API
160
-
The provider API is highly experimental and can change between patches. If you just need to run tests in a browser, use the [`browser.instances`](#browser-instances) option instead.
161
-
:::
162
158
163
159
Path to a provider that will be used when running browser tests. Vitest provides three providers which are `preview` (default), `webdriverio` and `playwright`. Custom providers should be exported using `default` export and have this shape:
164
160
···
180
176
}
181
177
```
182
178
179
+
::: danger ADVANCED API
180
+
The custom provider API is highly experimental and can change between patches. If you just need to run tests in a browser, use the [`browser.instances`](#browser-instances) option instead.
181
+
:::
182
+
183
183
## browser.providerOptions <Badge type="danger">deprecated</Badge> {#browser-provideroptions}
184
184
185
185
- **Type:** `BrowserProviderOptions`
186
186
187
-
::: danger
187
+
::: danger DEPRECATED
188
188
This API is deprecated an will be removed in Vitest 4. Please, use [`browser.instances`](#browser-instances) option instead.
189
189
:::
190
190
···
300
300
- **Type:** `BrowserScript[]`
301
301
- **Default:** `[]`
302
302
303
-
::: danger
303
+
::: danger DEPRECATED
304
304
This API is deprecated an will be removed in Vitest 4. Please, use [`browser.testerHtmlPath`](#browser-testerhtmlpath) field instead.
305
305
:::
306
306