playwright/docs/src/test-reporter-api/class-suite.md

# class: Suite
* since: v1.10
* langs: js

`Suite` is a group of tests. All tests in Playwright Test form the following hierarchy:

* Root suite has a child suite for each [TestProject].
  * Project suite #1. Has a child suite for each test file in the project.
    * File suite #1
      * [TestCase] #1
      * [TestCase] #2
      * Suite corresponding to a [`method: Test.describe#1`] group
        * [TestCase] #1 in a group
        * [TestCase] #2 in a group
      * < more test cases ... >
    * File suite #2
    * < more file suites ... >
  * Project suite #2
  * < more project suites ... >

Reporter is given a root suite in the [`method: Reporter.onBegin`] method.

## method: Suite.allTests
* since: v1.10
- returns: <[Array]<[TestCase]>>

Returns the list of all test cases in this suite and its descendants, as opposite to [`property: Suite.tests`].

## property: Suite.location
* since: v1.10
- type: ?<[Location]>

Location in the source where the suite is defined. Missing for root and project suites.

## property: Suite.parent
* since: v1.10
- type: ?<[Suite]>

Parent suite, missing for the root suite.

## method: Suite.project
* since: v1.10
- returns: ?<[TestProject]>

Configuration of the project this suite belongs to, or [void] for the root suite.

## property: Suite.suites
* since: v1.10
- type: <[Array]<[Suite]>>

Child suites. See [Suite] for the hierarchy of suites.

## property: Suite.tests
* since: v1.10
- type: <[Array]<[TestCase]>>

Test cases in the suite. Note that only test cases defined directly in this suite are in the list. Any test cases defined in nested [`method: Test.describe#1`] groups are listed
in the child [`property: Suite.suites`].

## property: Suite.title
* since: v1.10
- type: <[string]>

Suite title.
* Empty for root suite.
* Project name for project suite.
* File path for file suite.
* Title passed to [`method: Test.describe#1`] for a group suite.

## method: Suite.titlePath
* since: v1.10
- returns: <[Array]<[string]>>

Returns a list of titles from the root down to this suite.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`# class: Suite`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`* langs: js`

			`Suite` is a group of tests. All tests in Playwright Test form the following hierarchy:

			`* Root suite has a child suite for each [TestProject].`
			`* Project suite #1. Has a child suite for each test file in the project.`
			`* File suite #1`
			`* [TestCase] #1`
			`* [TestCase] #2`
feat(runner): anonymous describes (#15424) Useful to set some options without coming up with an artificial name. ```js test.describe(() => { test.use({ colorScheme: 'dark' }); test('my test', () => {}); }) ``` 2022-07-06 22:54:11 +02:00			* Suite corresponding to a [`method: Test.describe#1`] group
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`* [TestCase] #1 in a group`
			`* [TestCase] #2 in a group`
			`* < more test cases ... >`
			`* File suite #2`
			`* < more file suites ... >`
			`* Project suite #2`
			`* < more project suites ... >`

			Reporter is given a root suite in the [`method: Reporter.onBegin`] method.

			`## method: Suite.allTests`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- returns: <[Array]<[TestCase]>>`

			Returns the list of all test cases in this suite and its descendants, as opposite to [`property: Suite.tests`].

			`## property: Suite.location`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-07 04:02:10 +02:00			`- type: ?<[Location]>`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-07 04:02:10 +02:00			`Location in the source where the suite is defined. Missing for root and project suites.`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
feat(reporter): expose more apis (#9603) 2021-10-19 17:38:04 +02:00			`## property: Suite.parent`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-07 04:02:10 +02:00			`- type: ?<[Suite]>`
feat(reporter): expose more apis (#9603) 2021-10-19 17:38:04 +02:00
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-07 04:02:10 +02:00			`Parent suite, missing for the root suite.`
feat(reporter): expose more apis (#9603) 2021-10-19 17:38:04 +02:00
docs: Suite.project is a method, not a property (#10135) 2021-11-08 19:08:46 +01:00			`## method: Suite.project`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-07 04:02:10 +02:00			`- returns: ?<[TestProject]>`
feat(reporter): expose more apis (#9603) 2021-10-19 17:38:04 +02:00
			`Configuration of the project this suite belongs to, or [void] for the root suite.`

docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`## property: Suite.suites`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[Array]<[Suite]>>`

			`Child suites. See [Suite] for the hierarchy of suites.`

			`## property: Suite.tests`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[Array]<[TestCase]>>`

feat(runner): anonymous describes (#15424) Useful to set some options without coming up with an artificial name. ```js test.describe(() => { test.use({ colorScheme: 'dark' }); test('my test', () => {}); }) ``` 2022-07-06 22:54:11 +02:00			Test cases in the suite. Note that only test cases defined directly in this suite are in the list. Any test cases defined in nested [`method: Test.describe#1`] groups are listed
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			in the child [`property: Suite.suites`].

			`## property: Suite.title`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[string]>`

			`Suite title.`
			`* Empty for root suite.`
			`* Project name for project suite.`
			`* File path for file suite.`
feat(runner): anonymous describes (#15424) Useful to set some options without coming up with an artificial name. ```js test.describe(() => { test.use({ colorScheme: 'dark' }); test('my test', () => {}); }) ``` 2022-07-06 22:54:11 +02:00			* Title passed to [`method: Test.describe#1`] for a group suite.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`## method: Suite.titlePath`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- returns: <[Array]<[string]>>`

			`Returns a list of titles from the root down to this suite.`