Skip to content

Commit da4d0e6

Browse files
andrewslotinandrewslotin
authored
Merge pull request #1157 from grafana/update-browser-docs
Update k6 browser API docs
2 parents 8604dc1 + 84357e4 commit da4d0e6

File tree

3 files changed

+33
-19
lines changed

3 files changed

+33
-19
lines changed

src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/11-request.md renamed to src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/11 Request.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ excerpt: "Browser module: Request Class"
1818
| <a href="https://playwright.dev/docs/api/class-request#request-method" target="_blank" >request.method()</a> | - |
1919
| <a href="https://playwright.dev/docs/api/class-request#request-post-data" target="_blank" >request.postData()</a> | - |
2020
| <a href="https://playwright.dev/docs/api/class-request#request-post-data-buffer" target="_blank" >request.postDataBuffer()</a> | - |
21+
| <a href="https://playwright.dev/docs/api/class-request#request-redirected-from" target="_blank" >request.redirectedFrom()</a> | - |
22+
| <a href="https://playwright.dev/docs/api/class-request#request-redirected-to" target="_blank" >request.redirectedTo()</a> | - |
2123
| <a href="https://playwright.dev/docs/api/class-request#request-resource-type" target="_blank" >request.resourceType()</a> | - |
2224
| <a href="https://playwright.dev/docs/api/class-request#request-response" target="_blank" >request.response()</a> | - |
23-
| <a href="https://playwright.dev/docs/api/class-request#request-sizes" target="_blank" >request.sizes()</a> | - |
25+
| [request.size()](/javascript-api/k6-experimental/browser/request/size) | Unlike Playwright, this method returns an object containing the sizes of request headers and body. |
2426
| <a href="https://playwright.dev/docs/api/class-request#request-timing" target="_blank" >request.timing()</a> | - |
2527
| <a href="https://playwright.dev/docs/api/class-request#request-url" target="_blank" >request.url()</a> | - |

‎src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/11 Request/size.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: 'size()'
3+
excerpt: 'Browser module: Request.size method'
4+
---
5+
6+
Similar to Playwright's [`request.sizes()`](https://playwright.dev/docs/api/class-request#request-sizes), this method returns the size (in bytes) of body and header sections of the [Request](/javascript-api/k6-experimental/browser/request).
7+
8+
### Returns
9+
10+
| Type | Description |
11+
|--------|---------------------------------------|
12+
| object | `{ body: <bytes>, headers: <bytes> }` |

‎src/data/markdown/docs/02 javascript api/07 k6-experimental/01 browser/12-response.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ excerpt: "Browser module: Response Class"
77

88
## Supported APIs
99

10-
| Method | Playwright Relevant Distinctions |
11-
| - | - |
12-
| <a href="https://playwright.dev/docs/api/class-response#response-all-headers" target="_blank" >response.allHeaders()</a> | - |
13-
| <a href="https://playwright.dev/docs/api/class-response#response-body" target="_blank" >response.body()</a> | - |
14-
| <a href="https://playwright.dev/docs/api/class-response#response-frame" target="_blank" >response.frame()</a> | - |
15-
| <a href="https://playwright.dev/docs/api/class-response#response-headers" target="_blank" >response.headers()</a> | - |
16-
| <a href="https://playwright.dev/docs/api/class-response#response-headers-array" target="_blank" >response.headersArray()</a> | - |
17-
| <a href="https://playwright.dev/docs/api/class-response#response-header-value" target="_blank" >response.headerValue(name)</a> | - |
18-
| <a href="https://playwright.dev/docs/api/class-response#response-header-values" target="_blank" >response.headerValues(name)</a> | - |
19-
| <a href="https://playwright.dev/docs/api/class-response#response-json" target="_blank" >response.json()</a> | - |
20-
| <a href="https://playwright.dev/docs/api/class-response#response-ok" target="_blank" >response.ok()</a> | - |
21-
| <a href="https://playwright.dev/docs/api/class-response#response-request" target="_blank" >response.request()</a> | - |
22-
| <a href="https://playwright.dev/docs/api/class-response#response-security-details" target="_blank" >response.securityDetails()</a> | - |
23-
| <a href="https://playwright.dev/docs/api/class-response#response-server-addr" target="_blank" >response.serverAddr()</a> | - |
24-
| <a href="https://playwright.dev/docs/api/class-response#response-status" target="_blank" >response.status()</a> | - |
25-
| <a href="https://playwright.dev/docs/api/class-response#response-status-text" target="_blank" >response.statusText()</a> | - |
26-
| <a href="https://playwright.dev/docs/api/class-response#response-text" target="_blank" >response.text()</a> | - |
27-
| <a href="https://playwright.dev/docs/api/class-response#response-url" target="_blank" >response.url()</a> | - |
10+
| Method | Playwright Relevant Distinctions | Description |
11+
| - | - | - |
12+
| <a href="https://playwright.dev/docs/api/class-response#response-all-headers" target="_blank" >response.allHeaders()</a> | - | - |
13+
| <a href="https://playwright.dev/docs/api/class-response#response-body" target="_blank" >response.body()</a> | - | - |
14+
| <a href="https://playwright.dev/docs/api/class-response#response-frame" target="_blank" >response.frame()</a> | - | - |
15+
| <a href="https://playwright.dev/docs/api/class-response#response-headers" target="_blank" >response.headers()</a> | - | - |
16+
| <a href="https://playwright.dev/docs/api/class-response#response-headers-array" target="_blank" >response.headersArray()</a> | - | - |
17+
| <a href="https://playwright.dev/docs/api/class-response#response-header-value" target="_blank" >response.headerValue(name)</a> | - | - |
18+
| <a href="https://playwright.dev/docs/api/class-response#response-header-values" target="_blank" >response.headerValues(name)</a> | - | - |
19+
| <a href="https://playwright.dev/docs/api/class-response#response-json" target="_blank" >response.json()</a> | - | - |
20+
| <a href="https://playwright.dev/docs/api/class-response#response-ok" target="_blank" >response.ok()</a> | - | - |
21+
| <a href="https://playwright.dev/docs/api/class-response#response-request" target="_blank" >response.request()</a> | - | - |
22+
| <a href="https://playwright.dev/docs/api/class-response#response-security-details" target="_blank" >response.securityDetails()</a> | - | - |
23+
| <a href="https://playwright.dev/docs/api/class-response#response-server-addr" target="_blank" >response.serverAddr()</a> | - | - |
24+
| <a href="https://playwright.dev/docs/api/class-response#response-status" target="_blank" >response.status()</a> | - | - |
25+
| <a href="https://playwright.dev/docs/api/class-response#response-status-text" target="_blank" >response.statusText()</a> | - | - |
26+
| response.size() | - | Similar to [`Request.size()`](/javascript-api/k6-experimental/browser/request/size), this returns the size of response headers and body sections. |
27+
| <a href="https://playwright.dev/docs/api/class-response#response-url" target="_blank" >response.url()</a> | - | - |

0 commit comments

Comments
 (0)