Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify how to use local test context #1829

Merged
merged 2 commits into from
Aug 10, 2022
Merged

docs: clarify how to use local test context #1829

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fe72f0
docs: clarify how to use local test context
Tanimodori Aug 10, 2022
1938154
docs: update docs of local test context
Tanimodori Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/guide/test-context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ it('should work', ({ foo }) => {

### TypeScript

To provide types for your custom context properties, you can aggregate the `TestContext` type by adding
To provide property types for all your custom contexts, you can aggregate the `TestContext` type by adding

```ts
declare module 'vitest' {
Expand All @@ -58,3 +58,20 @@ declare module 'vitest' {
}
```

If you want to provide property types only for specific `beforeEach`, `afterEach`, `it` and `test` hooks, you can pass the type as a generic.

```ts
interface LocalTestContext {
foo: string
}

beforeEach<LocalTestContext>(async (context) => {
// typeof context is 'TestContext & LocalTestContext'
context.foo = 'bar'
})

it<LocalTestContext>('should work', ({ foo }) => {
// typeof foo is 'string'
console.log(foo) // 'bar'
})
```