Skip to content

Commit

Permalink
docs: mention Custom type
Browse files Browse the repository at this point in the history
  • Loading branch information
sheremet-va committed Dec 5, 2024
1 parent efe2a7c commit 37178eb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/guide/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,19 @@ test('validation works', () => {
}, 1000) // Ok ✅
```

### `Custom` Type is Deprecated <Badge type="warning">experimental API</Badge> {#custom-type-is-deprecated}

The `Custom` type is now equal to the `Test` type. Note that Vitest updated the public types in 2.1 and changed exported names to `RunnerCustomCase` and `RunnerTestCase`:

```ts
import {
RunnerCustomCase, // [!code --]
RunnerTestCase, // [!code ++]
} from 'vitest'
```

If you are using `getCurrentSuite().custom()`, the `type` of the returned task is now is equal to `'test'`. The `Custom` type will be removed in Vitest 4.

## Migrating to Vitest 2.0

### Default Pool is `forks`
Expand Down

0 comments on commit 37178eb

Please sign in to comment.