Skip to content
Vitest 3
Main Navigation Guia & APIConfiguraçãoModo NavegadorAPI Avançada
3.2.0
2.1.9
1.6.1
0.34.6

Português – Brasil

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

Português – Brasil

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

Aparência

Sidebar Navigation

API

Node API

APIs Avançadas

API Vitest

TestProject

TestSpecification

Test Task API

TestCase

TestSuite

TestModule

TestCollection

API de Plugin

API do Runner

Reporters

Metadados da Tarefa

Guia

Executando Testes

Estendendo Relatores

Pool Personalizado

Configurando o Vitest

Referência da API de Teste

Nesta página

TestCollection ​

TestCollection representa uma coleção de suites e testes de nível superior dentro de uma suite ou um módulo. Ele também oferece métodos úteis para iteração.

INFO

A maioria dos métodos retorna um iterador em vez de um array para melhor desempenho, caso você não precise de todos os itens da coleção. Se você preferir trabalhar com um array, pode desestruturar o iterador: [...children.allSuites()].

Observe também que a própria coleção é um iterador:

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

size ​

O número de testes e suites na coleção.

WARNING

Este número inclui apenas testes e suites de nível superior, e não suites e testes aninhados.

at ​

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

Retorna o teste ou suite em um índice específico. Este método aceita índices negativos.

array ​

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

A mesma coleção, porém como um array. Isso é útil se você quiser usar métodos de Array como map e filter, que não são suportados pela implementação de TestCollection.

allSuites ​

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

Filtra todas as suites que pertencem a esta coleção e seus elementos filhos.

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 todos os testes que pertencem a esta coleção e seus elementos filhos.

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

Você pode fornecer um valor state para filtrar testes por estado.

tests ​

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

Filtra somente os testes pertencentes a esta coleção. Você pode fornecer um valor state para filtrar testes por estado.

suites ​

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

Filtra apenas as suites que fazem parte desta coleção.

Pager
AnteriorTestModule
PróximoAPI de Plugin

Distribuído sob a Licença MIT.

Copyright (c) 2021-Present Vitest Team

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

Distribuído sob a Licença MIT.

Copyright (c) 2021-Present Vitest Team