-
Notifications
You must be signed in to change notification settings - Fork 213
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.
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
base: main
Are you sure you want to change the base?
Conversation
updated networkProfile parameters to reflect the correct values. They were missing Throughput
This comment was marked as resolved.
This comment was marked as resolved.
| 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. | |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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
.
updated networkProfile parameters to reflect the correct values. They were missing Throughput
What?
updated networkProfile parameters to reflect the correct values. They were missing Throughput keyword.
Checklist
npm start
command locally and verified that the changes look good.docs/sources/next
folder of the documentation.docs/sources/v0.50.x
folder of the documentation.Related PR(s)/Issue(s)