| Parameter | Type | Mandatory/Optional | Description | Example |
|---|---|---|---|---|
| lhConfig | object | Optional | Allows you to pass Lighthouse-specific configurations | “lhConfig”:{ |
| extends: “lighthouse:default”, } | ||||
| formFactor | string | Optional | Allows you to include or exclude mobile-specific audits for performance metrics. Possible values for the argument: mobile (default), desktop
|
“formFactor”: “mobile” |
| screenEmulation | object | Optional | Allows you to set the screen emulation parameters | “screenEmulation”: { } |
| mobile | boolean | Optional | Allows you to apply overlay scrollbars and other mobile-specific screen emulation | “mobile”: true |
| width | integer | Optional | Allows you to set the width of the screen | “width”: 412 |
| height | integer | Optional | Allows you to set the height of the screen | “height”: 823 |
| deviceScaleFactor | float | Optional | Allows you to set the device scale factor | “deviceScaleFactor”: 1.75 |
| disabled | boolean | Optional | Allows you to disable the emulation | “disabled”: false |
| emulatedUserAgent | string | Optional | Allows you to pass you agent value | “emulatedUserAgent”: “Mozilla/5.0 (Linux; Android 11; moto g power (2022)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Mobile Safari/537.36” |
| throttlingMethod | string | Optional | Allows you to enable or disable throttling. Valid values for the argument: simulate (default), provided (this disables the lighthouse default throttling) |
“throttlingMethod”: “simulate” |
| throttling | string | Optional | Allows you to set predefined throttling parameters. Possible values for the argument: mobileSlow4G (default), mobileRegular3G, desktopDense4G
|
“throttling”: “mobileRegular3G” |
| lhConfig.throttling | object | Optional | Allows you to set custom throttling parameters | |
| rttMs | integer | Optional | Represents the round-trip time in milliseconds | “rttMs”: 150 |
| throughputKbps | float | Optional | Represents the throughput in kilobits per second | “throughputKbps”: 1638.4 |
| requestLatencyMs | float | Optional | Represents the request latency in milliseconds | “requestLatencyMs”: 562.5 |
| downloadThroughputKbps | float | Optional | Represents the download throughput in kilobits per second | “downloadThroughputKbps”: 1474.5600000000002 |
| uploadThroughputKbps | float | Optional | Represents the upload throughput in kilobits per second | “uploadThroughputKbps”: 675 |
| cpuSlowdownMultiplier | integer | Optional | Represents the CPU slowdown multiplier | “cpuSlowdownMultiplier”: 4 |
| executorOutput | string | Optional | Allows you to get the Lighthouse report as a JSON response from the JavaScript executor | “executorOutput”: “json” |
| sessionFail | boolean | Optional | Allows you to mark the test session “failed” | “assertResult”: {“sessionFail”: true} |
| onlyCategories | array | Optional | Allows you to run specified categories | “lhConfig”:{ |
| extends: “lighthouse:default”,”onlyCategories”:[]} | ||||
| onlyAudits | array | Optional | Allows you to run specified audits | “lhConfig”:{ |
| extends: “lighthouse:default”,”onlyAudits”:[]} |
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Is this page helping you?
Yes
No
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!
