Skip to content
Vitest 3
Main Navigation Průvodce & APIKonfiguraceRežim prohlížečePokročilé API
3.2.0
2.1.9
1.6.1
0.34.6

čeština

English
简体中文
繁體中文
Español
Français
Русский
Português – Brasil
Deutsch
日本語
한국어
Italiano
Polski
Türkçe
magyar

čeština

English
简体中文
繁體中文
Español
Français
Русский
Português – Brasil
Deutsch
日本語
한국어
Italiano
Polski
Türkçe
magyar

Vzhled

Sidebar Navigation

API

Node API

Rozšířené API

Vitest API

TestProject

TestSpecification

Test Task API

TestCase

TestSuite

TestModule

TestCollection

Plugin API

Runner API

Reportéry

Metadata úloh

Průvodce

Spouštění testů

Rozšíření reportérů

Vlastní pool

Konfigurace Vitestu

Testovací reference API

Na této stránce

TestSpecification ​

Třída TestSpecification popisuje modul, který má být spuštěn jako test, a jeho parametry.

Specifikaci lze vytvořit pouze voláním metody createSpecification na testovacím projektu:

ts
const specification = project.createSpecification(
  resolve('./example.test.ts'),
  [20, 40] // volitelné řádky testů
);

Metoda createSpecification očekává již vyřešené ID modulu. Automaticky soubor nevyřeší ani nezkontroluje, zda existuje v souborovém systému.

taskId ​

Identifikátor testovacího modulu.

project ​

Tato reference odkazuje na TestProject, ke kterému testovací modul patří.

moduleId ​

ID modulu v grafu modulů Vite. Obvykle se jedná o absolutní cestu k souboru s použitím oddělovače POSIX:

ts
'C:/Users/Documents/project/example.test.ts'; // ✅
'/Users/mac/project/example.test.ts'; // ✅
'C:\\Users\\Documents\\project\\example.test.ts'; // ❌

testModule ​

Instance TestModule přidružená ke specifikaci. Pokud test ještě nebyl zařazen do fronty testů, bude hodnota undefined.

pool experimentální ​

pool, ve kterém se testovací modul spustí.

DANGER

Je možné mít více poolů v jednom testovacím projektu pomocí poolMatchGlob a typecheck.enabled. To znamená, že je možné mít několik specifikací se stejným moduleId, ale jiným pool. Ve Vitest 4 bude projekt podporovat pouze jeden pool a tato vlastnost bude odstraněna.

testLines ​

Toto je pole čísel řádků ve zdrojovém kódu, kde jsou definovány testy. Toto pole je definováno pouze v případě, že metoda createSpecification obdržela pole řádků.

Všimněte si, že pokud na alespoň jednom z uvedených řádků není žádný test, celá sada selže. Příklad správné konfigurace testLines:

ts
const specification = project.createSpecification(
  resolve('./example.test.ts'),
  [3, 8, 9]
);
ts
import { test, describe } from 'vitest'

test('verification works')

describe('a group of tests', () => { 
  // ...

  test('nested test')
  test.skip('skipped test')
})
1
2
3
4
5
6
7
8
9
10

toJSON ​

ts
function toJSON(): SerializedTestSpecification;

toJSON generuje objekt kompatibilní s JSON, který může být použit režimem prohlížeče (Browser Mode) nebo Vitest UI.

Pager
Předchozí stránkaTestProject
Další stránkaTestCase

Vydáno pod licencí MIT.

Copyright (c) 2021-Present Vitest Team

https://vitest.dev/advanced/api/test-specification

Vydáno pod licencí MIT.

Copyright (c) 2021-Present Vitest Team