docs: fix NetworkConditions descriptions (#11843)

This commit is contained in:
Alex Rudenko 2024-02-06 13:24:10 +01:00 committed by GitHub
parent c5cee0e37d
commit 799058cc7b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 8 deletions

View File

@ -13,7 +13,7 @@ export interface NetworkConditions
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| -------- | --------- | ------ | ----------- | ------- | | -------- | --------- | ------ | ------------------------ | ------- |
| download | | number | | | | download | | number | Download speed (bytes/s) | |
| latency | | number | | | | latency | | number | Latency (ms) | |
| upload | | number | | | | upload | | number | Upload speed (bytes/s) | |

View File

@ -36,11 +36,17 @@ export interface Credentials {
* @public * @public
*/ */
export interface NetworkConditions { export interface NetworkConditions {
// Download speed (bytes/s) /**
* Download speed (bytes/s)
*/
download: number; download: number;
// Upload speed (bytes/s) /**
* Upload speed (bytes/s)
*/
upload: number; upload: number;
// Latency (ms) /**
* Latency (ms)
*/
latency: number; latency: number;
} }