Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: update type property description (#30516)

Browse source
This commit is contained in:
Yury Semikhatsky 2024-04-24 13:10:17 -07:00 committed by GitHub
parent 9914b35c96
commit 4e086e6df8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/src/test-reporter-api/class-suite.md
View file

@ -30,7 +30,7 @@ Returns the list of all test cases in this suite and its descendants, as opposit
* since: v1.44 * since: v1.44
- type: <[Array]<[TestCase]|[Suite]>> - type: <[Array]<[TestCase]|[Suite]>>
Test cases and suites defined directly in this suite. The elements are returned in their declaration order. You can discriminate between different entry types using [`property: TestCase.type`] and [`property: Suite.type`]. Test cases and suites defined directly in this suite. The elements are returned in their declaration order. You can differentiate between various entry types by using [`property: TestCase.type`] and [`property: Suite.type`].
## property: Suite.location ## property: Suite.location
* since: v1.10 * since: v1.10

2
docs/src/test-reporter-api/class-testcase.md
View file

@ -112,4 +112,4 @@ Returns a list of titles from the root down to this test.
* since: v1.44 * since: v1.44
- returns: <[TestCaseType]<"test">> - returns: <[TestCaseType]<"test">>
Returns type of the test. Returns "test". Useful for detecting test cases in [`method: Suite.entries`].

5
packages/playwright/types/testReporter.d.ts vendored
View file

@ -578,7 +578,7 @@ export interface Suite {
/** /**
* Test cases and suites defined directly in this suite. The elements are returned in their declaration order. You can * Test cases and suites defined directly in this suite. The elements are returned in their declaration order. You can
* discriminate between different entry types using * differentiate between various entry types by using
* [testCase.type](https://playwright.dev/docs/api/class-testcase#test-case-type) and * [testCase.type](https://playwright.dev/docs/api/class-testcase#test-case-type) and
* [suite.type](https://playwright.dev/docs/api/class-suite#suite-type). * [suite.type](https://playwright.dev/docs/api/class-suite#suite-type).
*/ */
@ -770,7 +770,8 @@ export interface TestCase {
title: string; title: string;
/** /**
* Returns type of the test. * Returns "test". Useful for detecting test cases in
* [suite.entries()](https://playwright.dev/docs/api/class-suite#suite-entries).
*/ */
type: "test"; type: "test";
} }