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

docs: remove toc and api ref for events page (#17100)

Browse source
This commit is contained in:
Debbie O'Brien 2022-09-07 13:08:51 +02:00 committed by GitHub
parent ca753e1884
commit b13bedba57
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/src/events.md
View file

@ -3,15 +3,13 @@ id: events
title: "Events" title: "Events"
--- ---
Playwright allows listening to various types of events happening in the web page, such Playwright allows listening to various types of events happening on the web page, such as network requests, creation of child pages, dedicated workers etc. There are several ways to subscribe to such events such as waiting for events or adding or removing event listeners.
as network requests, creation of child pages, dedicated workers etc. There are several
ways to subscribe to such events:
## Waiting for event ## Waiting for event
Most of the time, scripts will need to wait for a particular event to happen. Below are some of the typical event awaiting patterns. Most of the time, scripts will need to wait for a particular event to happen. Below are some of the typical event awaiting patterns.
Wait for a request with the specified url: Wait for a request with the specified url using [`method: Page.waitForRequest`]:
```js ```js
// Note that Promise.all prevents a race condition // Note that Promise.all prevents a race condition
@ -53,7 +51,7 @@ var request = await waitForRequestTask;
Console.WriteLine(request.Url); Console.WriteLine(request.Url);
``` ```
Wait for popup window: Wait for popup window using [method: Page.waitForEvent]:
```js ```js
// Note that Promise.all prevents a race condition // Note that Promise.all prevents a race condition
@ -99,8 +97,7 @@ await popup.GotoAsync("https://wikipedia.org");
## Adding/removing event listener ## Adding/removing event listener
Sometimes, events happen in random time and instead of waiting for them, they need to be handled. Sometimes, events happen in random time and instead of waiting for them, they need to be handled. Playwright supports traditional language mechanisms for subscribing and unsubscribing from the events:
Playwright supports traditional language mechanisms for subscribing and unsubscribing from the events:
```js ```js
page.on('request', request => console.log(`Request sent: ${request.url()}`)); page.on('request', request => console.log(`Request sent: ${request.url()}`));
@ -191,10 +188,3 @@ await page.evaluate("prompt('Enter a number:')")
page.once("dialog", lambda dialog: dialog.accept("2021")) page.once("dialog", lambda dialog: dialog.accept("2021"))
page.evaluate("prompt('Enter a number:')") page.evaluate("prompt('Enter a number:')")
``` ```
### API reference
- [Browser]
- [BrowserContext]
- [Page]
- [Worker]