Skip to content
Vitest 3
Main Navigation Leitfaden & APIKonfigurationBrowser-ModusFortgeschritten API
3.2.0
2.1.9
1.6.1
0.34.6

Deutsch

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

Deutsch

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

Aussehen

Sidebar Navigation

API

Node API

Erweiterte API

Vitest API

TestProject

TestSpecification

Test Task API

TestCase

TestSuite

TestModule

TestCollection

Plugin-API

Runner API

Reporter

Aufgaben-Metadaten

Leitfaden

Tests ausführen

Reporter erweitern

Benutzerdefinierter Pool

Vitest konfigurieren

Test-API-Referenz

Auf dieser Seite

TestCollection ​

TestCollection repräsentiert eine Sammlung von Suites und Tests auf der obersten Ebene innerhalb einer Suite oder eines Moduls. Sie bietet auch nützliche Methoden zur Iteration über ihre Elemente.

INFO

Die meisten Methoden geben einen Iterator anstelle eines Arrays zurück, um die Performance zu verbessern, falls nicht jedes Element in der Sammlung benötigt wird. Wenn Sie lieber mit Arrays arbeiten möchten, können Sie den Iterator in ein Array umwandeln: [...children.allSuites()].

Beachten Sie auch, dass die Sammlung selbst ein Iterator ist:

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

size ​

Die Anzahl der Tests und Suiten in der Sammlung.

WARNING

Diese Zahl umfasst nur Tests und Suiten auf der obersten Ebene; verschachtelte Suiten und Tests sind nicht enthalten.

at ​

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

Diese Methode gibt den Test oder die Suite an einem bestimmten Index zurück. Negative Indizes werden unterstützt.

array ​

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

Diese Methode gibt dieselbe Sammlung als Array zurück. Dies ist nützlich, wenn Sie Array-Methoden wie map und filter verwenden möchten, die von der TestCollection-Implementierung nicht direkt unterstützt werden.

allSuites ​

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

Diese Methode filtert alle Suiten, die Teil dieser Sammlung und ihrer untergeordneten Elemente sind.

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>;

Diese Methode filtert alle Tests, die Teil dieser Sammlung und ihrer untergeordneten Elemente sind.

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

Sie können einen state-Wert übergeben, um Tests nach ihrem Zustand zu filtern.

tests ​

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

Diese Methode filtert nur die Tests, die direkt Teil dieser Sammlung sind. Sie können einen state-Wert übergeben, um Tests nach ihrem Zustand zu filtern.

suites ​

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

Diese Methode filtert nur die Suiten, die direkt Teil dieser Sammlung sind.

Pager
Vorherige SeiteTestModule
Nächste SeitePlugin-API

Veröffentlicht unter der MIT-Lizenz.

Copyright (c) 2021-Present Vitest Team

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

Veröffentlicht unter der MIT-Lizenz.

Copyright (c) 2021-Present Vitest Team