Skip to content
Vitest 3
Main Navigation ガイド & API設定ブラウザモード高度なAPI
3.2.0
2.1.9
1.6.1
0.34.6

日本語

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

日本語

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

外観

Sidebar Navigation

API

Node API

上級者向けAPI

Vitest API

TestProject

TestSpecification

Test Task API

TestCase

TestSuite

TestModule

TestCollection

プラグイン API

Runner API

レポーター

タスクのメタデータ

ガイド

テストの実行

レポーターの拡張

カスタムプール

Vitest の設定

テストAPIリファレンス

このページの内容

TestSpecification ​

TestSpecification クラスは、テストとして実行するモジュールとそのパラメーターを定義します。

この仕様は、テストプロジェクトの createSpecification メソッドを呼び出すことによってのみ作成できます。

ts
const specification = project.createSpecification(
  resolve('./example.test.ts'),
  [20, 40] // オプションのテスト行
);

createSpecification は解決済みのモジュール ID を必要とします。ファイルの自動解決や、ファイルシステム上での存在確認は行いません。

taskId ​

テストモジュールの識別子です。

project ​

テストモジュールが属する TestProject を参照します。

moduleId ​

Vite のモジュールグラフにおけるモジュール ID です。通常、POSIX セパレーター形式の絶対ファイルパスです。

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

testModule ​

仕様に関連付けられた TestModule のインスタンスです。テストがまだキューに登録されていない場合、これは undefined となります。

pool experimental ​

テストモジュールが実行される pool です。

DANGER

poolMatchGlob と typecheck.enabled を使用すると、単一のテストプロジェクトに複数のプールを持たせることが可能です。これは、同じ moduleId を持ちながら異なる pool を持つ複数の仕様が存在しうることを意味します。Vitest 4 では、プロジェクトは単一のプールのみをサポートするため、このプロパティは削除されます。

testLines ​

ソースコード内でテストファイルが定義されている行の配列です。このフィールドは、createSpecification メソッドに配列が渡された場合にのみ定義されます。

いずれかの行にテストが存在しない場合、スイート全体が失敗することに注意してください。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 は、ブラウザモードまたは Vitest UI で使用できる JSON 形式のオブジェクトを生成します。

Pager
前のページTestProject
次のページTestCase

MITライセンス の下で公開されています。

Copyright (c) 2021-Present Vitest Team

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

MITライセンス の下で公開されています。

Copyright (c) 2021-Present Vitest Team