Skip to content
Vitest 3
Main Navigation Przewodnik & APIKonfiguracjaTryb przeglądarkiZaawansowane API
3.2.0
2.1.9
1.6.1
0.34.6

Polski

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

Polski

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

Wygląd

Sidebar Navigation

API

Node API

Zaawansowane API

Vitest API

TestProject

TestSpecification

Test Task API

TestCase

TestSuite

TestModule

TestCollection

API wtyczek

API modułu uruchamiającego

Reportery

Metadane zadań

Przewodnik

Uruchamianie testów

Rozszerzanie Reporterów

Niestandardowa pula

Konfiguracja Vitest

Dokumentacja API testowego

Na tej stronie

TestCollection ​

TestCollection reprezentuje kolekcję zestawów testów i przypadków testowych najwyższego poziomu w danym zestawie lub module. Udostępnia również przydatne metody do iterowania po tej kolekcji.

INFO

Większość metod zwraca iterator zamiast tablicy, co zapewnia lepszą efektywność, jeśli nie potrzebujesz wszystkich elementów kolekcji. Jeśli wolisz pracować z tablicą, możesz rozwinąć iterator: [...children.allSuites()].

Zauważ również, że sama kolekcja jest iteratorem:

ts
for (const child of module.children) {
  console.log(child.type, child.name);
}

size ​

Liczba testów i zestawów znajdujących się bezpośrednio w kolekcji.

WARNING

Ta liczba obejmuje tylko testy i zestawy na najwyższym poziomie, nie obejmuje zagnieżdżonych zestawów i testów.

at ​

ts
function at(index: number): TestCase | TestSuite | undefined;

Zwraca test lub zestaw pod określonym indeksem. Ta metoda akceptuje indeksy ujemne.

array ​

ts
function array(): (TestCase | TestSuite)[];

Kolekcja w formie tablicy. Jest to przydatne, jeśli chcesz używać metod Array takich jak map i filter, które nie są obsługiwane bezpośrednio przez implementację TestCollection.

allSuites ​

ts
function allSuites(): Generator<TestSuite, undefined, void>;

Zwraca wszystkie zestawy, które są częścią tej kolekcji oraz jej elementów podrzędnych (w tym zagnieżdżonych).

ts
for (const suite of module.children.allSuites()) {
  if (suite.errors().length) {
    console.log('failed to collect', suite.errors());
  }
}

allTests ​

ts
function allTests(state?: TestState): Generator<TestCase, undefined, void>;

Zwraca wszystkie testy, które są częścią tej kolekcji oraz jej elementów podrzędnych (w tym zagnieżdżonych).

ts
for (const test of module.children.allTests()) {
  if (test.result().state === 'pending') {
    console.log('test', test.fullName, 'did not finish');
  }
}

Możesz przekazać wartość state, aby filtrować testy według ich stanu.

tests ​

ts
function tests(state?: TestState): Generator<TestCase, undefined, void>;

Filtruje i zwraca tylko testy znajdujące się bezpośrednio w tej kolekcji. Możesz przekazać wartość state, aby filtrować testy według ich stanu.

suites ​

ts
function suites(): Generator<TestSuite, undefined, void>;

Filtruje i zwraca tylko zestawy znajdujące się bezpośrednio w tej kolekcji.

Pager
Poprzednia stronaTestModule
Następna stronaAPI wtyczek

Opublikowano na licencji MIT.

Copyright (c) 2021-Present Vitest Team

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

Opublikowano na licencji MIT.

Copyright (c) 2021-Present Vitest Team