yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify response and requestfinished events (#3532)

Browse Source 
* docs: clarify response and requestfinished events

* fix typo
This commit is contained in:
Arjun Attam 2020-08-19 13:36:56 -07:00 committed by GitHub
parent a65b0bba5d
commit a78d83e833
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.md
View File

@ -902,12 +902,12 @@ Emitted when a request fails, for example by timing out.
#### event: 'requestfinished' #### event: 'requestfinished'
- <[Request]> - <[Request]>
Emitted when a request finishes successfully. Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is `request`, `response` and `requestfinished`.
#### event: 'response' #### event: 'response'
- <[Response]> - <[Response]>
Emitted when a [response] is received. Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events is `request`, `response` and `requestfinished`.
#### event: 'worker' #### event: 'worker'
- <[Worker]> - <[Worker]>
@ -3629,9 +3629,9 @@ Dispatches a `mouseup` event.
### class: Request ### class: Request
Whenever the page sends a request, such as for a network resource, the following events are emitted by playwright's page: Whenever the page sends a request for a network resource the following sequence of events are emitted by [Page]:
- [`'request'`](#event-request) emitted when the request is issued by the page. - [`'request'`](#event-request) emitted when the request is issued by the page.
- [`'response'`](#event-response) emitted when/if the response is received for the request. - [`'response'`](#event-response) emitted when/if the response status and headers are received for the request.
- [`'requestfinished'`](#event-requestfinished) emitted when the response body is downloaded and the request is complete. - [`'requestfinished'`](#event-requestfinished) emitted when the response body is downloaded and the request is complete.
If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event), the [`'requestfailed'`](#event-requestfailed) event is emitted. If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event), the [`'requestfailed'`](#event-requestfailed) event is emitted.