Test Context

Inspired by Playwright Fixtures, Vitest's test context allows you to define utils, states, and fixtures that can be used in your tests.

Usage

The first argument or each test callback is a test context.

import { it } from 'vitest'

it('should work', (ctx) => {
  // prints name of the test
  console.log(ctx.meta.name)
})

import { it } from 'vitest'

it('should work', (ctx) => {
  // prints name of the test
  console.log(ctx.meta.name)
})

Built-in Test Context

`context.meta`

A readonly object containing metadata about the test.

`context.expect`

The expect API which bound to the current test.

Extend Test Context

The contexts are different for each test. You can access and extend them within the beforeEach and afterEach hooks.

import { beforeEach, it } from 'vitest'

beforeEach(async (context) => {
  // extend context
  context.foo = 'bar'
})

it('should work', ({ foo }) => {
  console.log(foo) // 'bar'
})

import { beforeEach, it } from 'vitest'

beforeEach(async (context) => {
  // extend context
  context.foo = 'bar'
})

it('should work', ({ foo }) => {
  console.log(foo) // 'bar'
})

TypeScript

To provide type for your custom context properties, you can aggregate the type TestContext by adding

declare module 'vitest' {
  export interface TestContext {
    foo?: string
  }
}

declare module 'vitest' {
  export interface TestContext {
    foo?: string
  }
}

Test Context #

Usage #

Built-in Test Context #

context.meta #

context.expect #

Extend Test Context #

TypeScript #