Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing browser request docs #1603

Merged
merged 24 commits into from
Jun 5, 2024
Merged

Add missing browser request docs #1603

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
2ad0581
Add example in index
ankur22 Jun 3, 2024
c8480c1
Add some details on how to retrieve the request
ankur22 Jun 3, 2024
82a7309
Add request.allHeaders doc
ankur22 May 31, 2024
626c037
Add request.frame doc
ankur22 May 31, 2024
c13c15e
Add request.headers doc
ankur22 Jun 3, 2024
c0f81d9
Add request.headersArray doc
ankur22 Jun 3, 2024
9e50564
Add request.headerValue doc
ankur22 Jun 3, 2024
44b8ad5
Add request.isNavigationRequest doc
ankur22 Jun 3, 2024
50e8efd
Add request.method doc
ankur22 Jun 3, 2024
346be4a
Add request.postData doc
ankur22 Jun 3, 2024
864bde9
Add request.postDataBuffer doc
ankur22 Jun 3, 2024
d91da5d
Add request.resourceType doc
ankur22 Jun 3, 2024
076b04e
Add request.response doc
ankur22 Jun 3, 2024
dd42112
Add request.timing doc
ankur22 Jun 3, 2024
b366672
Add some
ankur22 Jun 3, 2024
eea7618
Add request.url doc
ankur22 Jun 3, 2024
7d22b94
Add request.size example
ankur22 Jun 3, 2024
5506384
Update request reference without codeblock
ankur22 Jun 3, 2024
af3bc5a
Add missing "."
ankur22 Jun 3, 2024
338db8a
Update resourceType to resource type
ankur22 Jun 3, 2024
6f2167d
Update request.timing description
ankur22 Jun 3, 2024
26b0b1b
Refactor ResourceTiming type reference
ankur22 Jun 3, 2024
f8ae957
Update resourceType description wording
ankur22 Jun 3, 2024
a3d428c
Add null in codeblock
ankur22 Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/sources/next/javascript-api/k6-experimental/browser/request/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@ The `request` that the browser performs can be retrieved from the [Response](htt

## Supported APIs

| Method | Playwright Relevant Distinctions |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| [request.allHeaders()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/allheaders) {{< docs/bwipt id="965" >}} | Returns an object of headers associated to the request including headers added by the browser. |
| [request.frame()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/frame) | The [Frame](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/frame/) that initiated the request |
| [request.headers()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/headers) | Returns an object of headers associated to the request. |
| [request.headersArray()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/headersarray) | An array with all the request HTTP headers |
| [request.headerValue(name)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/headervalue) | Returns the value of the header matching the name. The name is case insensitive. |
| [request.isNavigationRequest()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/isnavigationrequest) | Returns a boolean stating whether the request is for a navigation. |
| [request.method()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/method) | Request's method (GET, POST, etc.). |
| [request.postData()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/postdata) | Contains the request's post body, if any. |
| [request.postDataBuffer()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/postdatabuffer) | Request's post body in a binary form, if any. |
| [request.resourceType()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/resourcetype) | Contains the request's resource type as it was perceived by the rendering engine. |
| <a href="https://playwright.dev/docs/api/class-request#request-response" target="_blank" >request.response()</a> | - |
| [request.size()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/size) | Unlike Playwright, this method returns an object containing the sizes of request headers and body. |
| <a href="https://playwright.dev/docs/api/class-request#request-timing" target="_blank" >request.timing()</a> | - |
| <a href="https://playwright.dev/docs/api/class-request#request-url" target="_blank" >request.url()</a> | - |
| Method | Playwright Relevant Distinctions |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| [request.allHeaders()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/allheaders) {{< docs/bwipt id="965" >}} | Returns an object of headers associated to the request including headers added by the browser. |
| [request.frame()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/frame) | The [Frame](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/frame/) that initiated the request |
| [request.headers()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/headers) | Returns an object of headers associated to the request. |
| [request.headersArray()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/headersarray) | An array with all the request HTTP headers |
| [request.headerValue(name)](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/headervalue) | Returns the value of the header matching the name. The name is case insensitive. |
| [request.isNavigationRequest()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/isnavigationrequest) | Returns a boolean stating whether the request is for a navigation. |
| [request.method()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/method) | Request's method (GET, POST, etc.). |
| [request.postData()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/postdata) | Contains the request's post body, if any. |
| [request.postDataBuffer()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/postdatabuffer) | Request's post body in a binary form, if any. |
| [request.resourceType()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/resourcetype) | Contains the request's resource type as it was perceived by the rendering engine. |
| [request.response()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/response) | Returns the matching [Response](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/response) object |
inancgumus marked this conversation as resolved.
Show resolved Hide resolved
| [request.size()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/request/size) | Unlike Playwright, this method returns an object containing the sizes of request headers and body. |
| <a href="https://playwright.dev/docs/api/class-request#request-timing" target="_blank" >request.timing()</a> | - |
| <a href="https://playwright.dev/docs/api/class-request#request-url" target="_blank" >request.url()</a> | - |

### Example

Expand Down
51 changes: 51 additions & 0 deletions docs/sources/next/javascript-api/k6-experimental/browser/request/response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: 'response()'
description: 'Browser module: Request.response method'
---

# response()

Returns the matching [Response](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/browser/response) object, or `null` if the response was not received due to error.

### Returns

| Type | Description |
| --------------------------- | ------------------------------------------------------------------------------ |
| `Promise<Response \| null>` | The `Response` object, or `null` if the response was not received due to error |

### Example

{{< code >}}

```javascript
import { browser } from 'k6/experimental/browser';

export const options = {
scenarios: {
ui: {
executor: 'shared-iterations',
options: {
browser: {
type: 'chromium',
},
},
},
},
};

export default async function () {
const page = await browser.newPage();

try {
const res = await page.goto('https://test.k6.io/');
const req = res.request();

const response = await req.response();
// ...
} finally {
await page.close();
}
}
```

{{< /code >}}