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

Update throttlenetwork.md #1575

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −2
Open

Update throttlenetwork.md #1575

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2cf5ff
Update throttlenetwork.md
gopikrishnan-p Apr 30, 2024
afe2faa
Merge branch 'main' into patch-1
gopikrishnan-p May 2, 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
4 changes: 2 additions & 2 deletions .../sources/v0.50.x/javascript-api/k6-experimental/browser/page/throttlenetwork.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Throttles the network in Chrome/Chromium to slow it down by the specified fields
| ----------------------- | -------------- | ------- | -------------------------------------------------------------------------------------- |
| networkProfile | NetworkProfile | `null` | This is a mandatory parameter. |
| networkProfile.latency | number | `0` | Minimum latency from request sent to response headers received (ms). |
| networkProfile.download | number | `-1` | Maximal aggregated download throughput (bytes/sec). `-1` disables download throttling. |
| networkProfile.upload | number | `-1` | Maximal aggregated upload throughput (bytes/sec). `-1` disables upload throttling. |
| networkProfile.downloadThroughput | number | `-1` | Maximal aggregated download throughput (bytes/sec). `-1` disables download throttling. |
| networkProfile.uploadThroughput | number | `-1` | Maximal aggregated upload throughput (bytes/sec). `-1` disables upload throttling. |
Comment on lines +14 to +15
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the change. The correct values should be download and upload. What's the reason for requesting the documentation change?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ankur22,
I was able to use both download and downloadThroughput values. Some of my older scripts which uses 'download' were failing for some reason. But now I see both are working while I did the testing. So if there are notes saying 'downloadThroughput' is deprecated or shouldn't be used it would be great!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was a brief moment where downloadThroughput and uploadThroughput were part of a PR when the API was being built, but they were never released as supported fields for this API. I would recommend changing your scripts to work with download and upload.


To work with the most commonly tested network profiles, import `networkProfiles` from the browser module. There are three profiles available:

Expand Down