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

NOW improved docs

Browse source 
Signed-off-by: René <snooz@posteo.de>
This commit is contained in:
René 2024-10-17 01:12:21 +02:00
parent 159bdb0312
commit d1ff9ff0f4
2 changed files with 37 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/src/api/class-tracing.md
View file

@ -286,11 +286,35 @@ To specify the final trace zip file name, you need to pass `path` option to
Creates a new inline group in the trace, causing any subsequent calls to belong to this group, until [`method: Tracing.groupEnd`] is called.
Groups can be nested and are similar to `test.step` in trace.
However, groups are only visualized in the trace viewer and, unlike test.step, have no effect on the test reports.
:::note Groups should not be used with Playwright Test!
This API is intended for Playwright API users that can not use `test.step`.
:::
**Usage**
```js
await context.tracing.start({ screenshots: true, snapshots: true });
await context.tracing.group('Open Playwright.dev');
// All actions between group and groupEnd will be shown in the trace viewer as a group.
const page = await context.newPage();
await page.goto('https://playwright.dev/');
await context.tracing.groupEnd();
await context.tracing.group('Open API Docs of Tracing');
await page.getByRole('link', { name: 'API' }).click();
await page.getByRole('link', { name: 'Tracing' }).click();
await context.tracing.groupEnd();
// This Trace will have two groups: 'Open Playwright.dev' and 'Open API Docs of Tracing'.
```
### param: Tracing.group.name
* since: v1.49
- `name` <[string]>
Group name shown in the trace viewer.
Group name shown in the actions tree in trace viewer.
### option: Tracing.group.location
* since: v1.49
@ -299,10 +323,13 @@ Group name shown in the trace viewer.
- `line` ?<[int]> Line number in the source file.
- `column` ?<[int]> Column number in the source file
Specifies a custom location for the group start to be shown in source tab in trace viewer.
By default, location of the tracing.group() call is shown.
## async method: Tracing.groupEnd
* since: v1.49
Closes the last opened inline group in the trace.
Closes the currently open inline group in the trace.
## async method: Tracing.stop
* since: v1.12

15
packages/playwright-core/types/types.d.ts vendored
View file

@ -21062,16 +21062,17 @@ export interface Tracing {
* Creates a new inline group in the trace, causing any subsequent calls to belong to this group, until
* [tracing.groupEnd()](https://playwright.dev/docs/api/class-tracing#tracing-group-end) is called.
*
* Groups can be nested and are similar to [test.step()](https://playwright.dev/docs/api/class-test#test-step) in trace.
* However, groups are only visualized in the trace viewer and, unlike test.step, have no effect on the test reports.
*
* **NOTE** Groups should not be used with Playwright Test! This API is intended for Playwright API users that can not use [test.step()](https://playwright.dev/docs/api/class-test#test-step).
* Groups can be nested and are similar to `test.step` in trace. However, groups are only visualized in the trace
* viewer and, unlike test.step, have no effect on the test reports.
*
* **NOTE** This API is intended for Playwright API users that can not use `test.step`.
*
* **Usage**
*
* ```js
* await context.tracing.start({ screenshots: true, snapshots: true });
* await context.tracing.group('Open Playwright.dev');
* // All actions between group and groupEnd will be shown in the trace viewer as a group.
* const page = await context.newPage();
* await page.goto('https://playwright.dev/');
* await context.tracing.groupEnd();
@ -21079,6 +21080,7 @@ export interface Tracing {
* await page.getByRole('link', { name: 'API' }).click();
* await page.getByRole('link', { name: 'Tracing' }).click();
* await context.tracing.groupEnd();
* // This Trace will have two groups: 'Open Playwright.dev' and 'Open API Docs of Tracing'.
* ```
*
* @param name Group name shown in the actions tree in trace viewer.
@ -21086,8 +21088,8 @@ export interface Tracing {
*/
group(name: string, options?: {
/**
* Specifies a custom location for the group start to be shown in source tab in trace viewer.
* By default, location of the tracing.group() call is shown.
* Specifies a custom location for the group start to be shown in source tab in trace viewer. By default, location of
* the tracing.group() call is shown.
*/
location?: {
/**
@ -21109,7 +21111,6 @@ export interface Tracing {
/**
* Closes the currently open inline group in the trace.
*
*/
groupEnd(): Promise<void>;