Update type docs

This commit is contained in:
Yury Semikhatsky 2024-03-28 17:36:17 -07:00
parent 218f2ffe35
commit 04118a1266
2 changed files with 9 additions and 4 deletions

View file

@ -30,7 +30,7 @@ Returns the list of all test cases in this suite and its descendants, as opposit
* since: v1.44
- type: <[Array]<[TestCase]|[Suite]>>
Test cases and suites defined directly in this suite. The elements returned in their declaration order.
Test cases and suites defined directly in this suite. The elements returned in their declaration order. You can discriminate between different entry types using [`property: TestCase.type`] and [`property: Suite.type`].
## property: Suite.location
* since: v1.10
@ -83,4 +83,5 @@ Returns a list of titles from the root down to this suite.
* since: v1.44
- returns: <[SuiteType]<'root' | 'project' | 'file' | 'describe'>>
Returns type of the suite.
Returns type of the suite. The Suites form the following hierarchy:
`root` -> `project` -> `file` -> `describe` -> ...`describe` -> `test`.

View file

@ -41,7 +41,8 @@ export type { FullConfig, TestStatus, FullProject } from './test';
*/
export interface Suite {
/**
* Returns type of the suite.
* Returns type of the suite. The Suites form the following hierarchy: `root` -> `project` -> `file` -> `describe` ->
* ...`describe` -> `test`.
*/
type: 'root' | 'project' | 'file' | 'describe';
/**
@ -55,7 +56,10 @@ export interface Suite {
allTests(): Array<TestCase>;
/**
* Test cases and suites defined directly in this suite. The elements returned in their declaration order.
* Test cases and suites defined directly in this suite. The elements returned in their declaration order. You can
* discriminate between different entry types using
* [testCase.type](https://playwright.dev/docs/api/class-testcase#test-case-type) and
* [suite.type](https://playwright.dev/docs/api/class-suite#suite-type).
*/
entries(): Array<TestCase|Suite>;