playwright/docs/out/api/class-response.md

136 lines
5.9 KiB
Markdown
Raw Normal View History

2021-01-01 15:17:27 -08:00
---
id: class-response
title: "Response"
2021-01-01 15:17:27 -08:00
---
[Response] class represents responses which are received by page.
- [response.body()](api/class-response.md#responsebody)
- [response.finished()](api/class-response.md#responsefinished)
- [response.frame()](api/class-response.md#responseframe)
- [response.headers()](api/class-response.md#responseheaders)
- [response.json()](api/class-response.md#responsejson)
- [response.ok()](api/class-response.md#responseok)
- [response.request()](api/class-response.md#responserequest)
- [response.status()](api/class-response.md#responsestatus)
- [response.statusText()](api/class-response.md#responsestatustext)
- [response.text()](api/class-response.md#responsetext)
- [response.url()](api/class-response.md#responseurl)
## response.body()
2021-01-01 15:17:27 -08:00
- returns: <[Promise]<[Buffer]>>
Returns the buffer with response body.
## response.finished()
2021-01-01 15:17:27 -08:00
- returns: <[Promise]<[null]|[Error]>>
Waits for this response to finish, returns failure error if request failed.
## response.frame()
2021-01-01 15:17:27 -08:00
- returns: <[Frame]>
Returns the [Frame] that initiated this response.
## response.headers()
2021-01-01 15:17:27 -08:00
- returns: <[Object]<[string], [string]>>
Returns the object with HTTP headers associated with the response. All header names are lower-case.
## response.json()
2021-01-01 15:17:27 -08:00
- returns: <[Promise]<[Serializable]>>
Returns the JSON representation of response body.
This method will throw if the response body is not parsable via `JSON.parse`.
## response.ok()
2021-01-01 15:17:27 -08:00
- returns: <[boolean]>
Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
## response.request()
2021-01-01 15:17:27 -08:00
- returns: <[Request]>
Returns the matching [Request] object.
## response.status()
2021-01-01 15:17:27 -08:00
- returns: <[number]>
Contains the status code of the response (e.g., 200 for a success).
## response.statusText()
2021-01-01 15:17:27 -08:00
- returns: <[string]>
Contains the status text of the response (e.g. usually an "OK" for a success).
## response.text()
2021-01-01 15:17:27 -08:00
- returns: <[Promise]<[string]>>
Returns the text representation of response body.
## response.url()
2021-01-01 15:17:27 -08:00
- returns: <[string]>
Contains the URL of the response.
2021-01-01 15:17:27 -08:00
[Playwright]: api/class-playwright.md "Playwright"
[Browser]: api/class-browser.md "Browser"
[BrowserContext]: api/class-browsercontext.md "BrowserContext"
[Page]: api/class-page.md "Page"
[Frame]: api/class-frame.md "Frame"
[ElementHandle]: api/class-elementhandle.md "ElementHandle"
[JSHandle]: api/class-jshandle.md "JSHandle"
[ConsoleMessage]: api/class-consolemessage.md "ConsoleMessage"
[Dialog]: api/class-dialog.md "Dialog"
[Download]: api/class-download.md "Download"
[Video]: api/class-video.md "Video"
[FileChooser]: api/class-filechooser.md "FileChooser"
[Keyboard]: api/class-keyboard.md "Keyboard"
[Mouse]: api/class-mouse.md "Mouse"
[Touchscreen]: api/class-touchscreen.md "Touchscreen"
[Request]: api/class-request.md "Request"
[Response]: api/class-response.md "Response"
[Selectors]: api/class-selectors.md "Selectors"
[Route]: api/class-route.md "Route"
[WebSocket]: api/class-websocket.md "WebSocket"
[TimeoutError]: api/class-timeouterror.md "TimeoutError"
[Accessibility]: api/class-accessibility.md "Accessibility"
[Worker]: api/class-worker.md "Worker"
[BrowserServer]: api/class-browserserver.md "BrowserServer"
[BrowserType]: api/class-browsertype.md "BrowserType"
[Logger]: api/class-logger.md "Logger"
[ChromiumBrowser]: api/class-chromiumbrowser.md "ChromiumBrowser"
[ChromiumBrowserContext]: api/class-chromiumbrowsercontext.md "ChromiumBrowserContext"
[ChromiumCoverage]: api/class-chromiumcoverage.md "ChromiumCoverage"
[CDPSession]: api/class-cdpsession.md "CDPSession"
[FirefoxBrowser]: api/class-firefoxbrowser.md "FirefoxBrowser"
[WebKitBrowser]: api/class-webkitbrowser.md "WebKitBrowser"
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
[Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer"
[ChildProcess]: https://nodejs.org/api/child_process.html "ChildProcess"
[Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element"
[Error]: https://nodejs.org/api/errors.html#errors_class_error "Error"
[Evaluation Argument]: ./core-concepts.md#evaluationargument "Evaluation Argument"
[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map "Map"
[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object "Object"
[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise"
[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp "RegExp"
[Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable"
[UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail"
[URL]: https://nodejs.org/api/url.html "URL"
[USKeyboardLayout]: ../src/usKeyboardLayout.ts "USKeyboardLayout"
[UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time"
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function"
[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator"
[null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null "null"
[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number"
[origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin"
[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector"
[Readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable "Readable"
[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type "string"
[xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"