Skip to content
Vitest 3
Main Navigation Guía & APIConfiguraciónModo NavegadorAPI avanzada
3.2.0
2.1.9
1.6.1
0.34.6

Español

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

Español

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

Apariencia

Sidebar Navigation

API

Node API

API Avanzadas

API de Vitest

TestProject

TestSpecification

Test Task API

TestCase

TestSuite

TestModule

TestCollection

API de Plugins

API del Runner

Reporteros

Metadatos de Tareas

Guía

Ejecución de Pruebas

Extensión de los Reporters

Pool Personalizado

Configuración de Vitest

Referencia de la API de prueba

En esta página

TestCollection ​

TestCollection representa una colección de suites y tests de primer nivel dentro de una suite o un módulo. También proporciona métodos útiles para iterar sobre sus elementos.

INFO

La mayoría de los métodos devuelven un iterador en lugar de un arreglo para un mejor rendimiento, especialmente si no necesita todos los elementos de la colección. Si prefiere trabajar con un arreglo, puede expandir el iterador: [...children.allSuites()].

Tenga también en cuenta que la colección misma es un iterador:

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

size ​

El número de tests y suites directamente contenidos en la colección.

WARNING

Este número incluye solo tests y suites de primer nivel; no incluye suites ni tests anidados.

at ​

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

Devuelve el test o la suite en un índice específico. Este método acepta índices negativos.

array ​

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

La misma colección, pero en forma de arreglo. Esto es útil si desea usar métodos de Array como map y filter que no son compatibles directamente con la implementación de TestCollection.

allSuites ​

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

Filtra y devuelve todas las suites que pertenecen a esta colección y a sus elementos secundarios (suites anidadas).

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

Filtra y devuelve todos los tests que pertenecen a esta colección y a sus elementos secundarios (tests anidados dentro de suites).

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

Puede proporcionar un valor state para filtrar los tests según su estado.

tests ​

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

Filtra y devuelve únicamente los tests que pertenecen directamente a esta colección (tests de primer nivel). Puede proporcionar un valor state para filtrar los tests según su estado.

suites ​

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

Filtra y devuelve solo las suites que pertenecen directamente a esta colección (suites de primer nivel).

Pager
AnteriorTestModule
SiguienteAPI de Plugins

Publicado bajo la licencia MIT.

Copyright (c) 2021-Present Vitest Team

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

Publicado bajo la licencia MIT.

Copyright (c) 2021-Present Vitest Team