Skip to content

Commit 53c9973

Browse files
authored
docs: clarify the custom provider API is experimental (#7855)
1 parent ed9ee9d commit 53c9973

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/guide/browser/config.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Under the hood, Vitest transforms these instances into separate [test projects](
110110
- **Type:** `string`
111111
- **CLI:** `--browser=safari`
112112

113-
::: danger
113+
::: danger DEPRECATED
114114
This API is deprecated an will be removed in Vitest 4. Please, use [`browser.instances`](#browser-instances) option instead.
115115
:::
116116

@@ -150,16 +150,12 @@ A path to the HTML entry point. Can be relative to the root of the project. This
150150

151151
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.
152152

153-
## browser.provider <Badge type="warning">experimental</Badge> {#browser-provider}
153+
## browser.provider {#browser-provider}
154154

155155
- **Type:** `'webdriverio' | 'playwright' | 'preview' | string`
156156
- **Default:** `'preview'`
157157
- **CLI:** `--browser.provider=playwright`
158158

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-
163159
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:
164160

165161
```ts
@@ -180,11 +176,15 @@ export interface BrowserProvider {
180176
}
181177
```
182178

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+
183183
## browser.providerOptions <Badge type="danger">deprecated</Badge> {#browser-provideroptions}
184184

185185
- **Type:** `BrowserProviderOptions`
186186

187-
::: danger
187+
::: danger DEPRECATED
188188
This API is deprecated an will be removed in Vitest 4. Please, use [`browser.instances`](#browser-instances) option instead.
189189
:::
190190

@@ -300,7 +300,7 @@ export interface BrowserScript {
300300
- **Type:** `BrowserScript[]`
301301
- **Default:** `[]`
302302

303-
::: danger
303+
::: danger DEPRECATED
304304
This API is deprecated an will be removed in Vitest 4. Please, use [`browser.testerHtmlPath`](#browser-testerhtmlpath) field instead.
305305
:::
306306

0 commit comments

Comments
 (0)